Class: Google::Cloud::Kms::V1::AutokeyConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/kms/v1/autokey_admin.rb

Overview

Cloud KMS Autokey configuration for a folder.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#key_project ⇒ ::String

Returns Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.

Returns:

  • (::String) —

    Optional. Name of the key project, e.g. projects/{PROJECT_ID} or projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require cloudkms.cryptoKeys.setIamPolicy permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the cloudkms.admin role (or pertinent permissions). A request with an empty key project field will clear the configuration.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/kms/v1/autokey_admin.rb', line 72

class AutokeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The states AutokeyConfig can be in.
  module State
    # The state of the AutokeyConfig is unspecified.
    STATE_UNSPECIFIED = 0

    # The AutokeyConfig is currently active.
    ACTIVE = 1

    # A previously configured key project has been deleted and the current
    # AutokeyConfig is unusable.
    KEY_PROJECT_DELETED = 2

    # The AutokeyConfig is not yet initialized or has been reset to its default
    # uninitialized state.
    UNINITIALIZED = 3
  end
end

#name ⇒ ::String

Returns Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.

Returns:

  • (::String) —

    Identifier. Name of the AutokeyConfig resource, e.g. folders/{FOLDER_NUMBER}/autokeyConfig.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/kms/v1/autokey_admin.rb', line 72

class AutokeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The states AutokeyConfig can be in.
  module State
    # The state of the AutokeyConfig is unspecified.
    STATE_UNSPECIFIED = 0

    # The AutokeyConfig is currently active.
    ACTIVE = 1

    # A previously configured key project has been deleted and the current
    # AutokeyConfig is unusable.
    KEY_PROJECT_DELETED = 2

    # The AutokeyConfig is not yet initialized or has been reset to its default
    # uninitialized state.
    UNINITIALIZED = 3
  end
end

#state ⇒ ::Google::Cloud::Kms::V1::AutokeyConfig::State (readonly)

Returns Output only. The state for the AutokeyConfig.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/kms/v1/autokey_admin.rb', line 72

class AutokeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The states AutokeyConfig can be in.
  module State
    # The state of the AutokeyConfig is unspecified.
    STATE_UNSPECIFIED = 0

    # The AutokeyConfig is currently active.
    ACTIVE = 1

    # A previously configured key project has been deleted and the current
    # AutokeyConfig is unusable.
    KEY_PROJECT_DELETED = 2

    # The AutokeyConfig is not yet initialized or has been reset to its default
    # uninitialized state.
    UNINITIALIZED = 3
  end
end