Class: Google::Cloud::NetApp::V1::KmsConfig

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

Overview

KmsConfig is the customer managed encryption key(CMEK) configuration.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Create time of the KmsConfig.

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#crypto_key_name ⇒ ::String

Returns Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.

Returns:

  • (::String) —

    Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#description ⇒ ::String

Returns Description of the KmsConfig.

Returns:

  • (::String) —

    Description of the KmsConfig.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#instructions ⇒ ::String (readonly)

Returns Output only. Instructions to provide the access to the customer provided encryption key.

Returns:

  • (::String) —

    Output only. Instructions to provide the access to the customer provided encryption key.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels as key value pairs.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels as key value pairs



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#name ⇒ ::String

Returns Identifier. Name of the KmsConfig.

Returns:

  • (::String) —

    Identifier. Name of the KmsConfig.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#service_account ⇒ ::String (readonly)

Returns Output only. The Service account which will have access to the customer provided encryption key.

Returns:

  • (::String) —

    Output only. The Service account which will have access to the customer provided encryption key.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#state ⇒ ::Google::Cloud::NetApp::V1::KmsConfig::State (readonly)

Returns Output only. State of the KmsConfig.

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end

#state_details ⇒ ::String (readonly)

Returns Output only. State details of the KmsConfig.

Returns:

  • (::String) —

    Output only. State details of the KmsConfig.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/netapp/v1/kms.rb', line 180

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The KmsConfig States
  module State
    # Unspecified KmsConfig State
    STATE_UNSPECIFIED = 0

    # KmsConfig State is Ready
    READY = 1

    # KmsConfig State is Creating
    CREATING = 2

    # KmsConfig State is Deleting
    DELETING = 3

    # KmsConfig State is Updating
    UPDATING = 4

    # KmsConfig State is In Use.
    IN_USE = 5

    # KmsConfig State is Error
    ERROR = 6

    # KmsConfig State is Pending to verify crypto key access.
    KEY_CHECK_PENDING = 7

    # KmsConfig State is Not accessbile by the SDE service account to the
    # crypto key.
    KEY_NOT_REACHABLE = 8

    # KmsConfig State is Disabling.
    DISABLING = 9

    # KmsConfig State is Disabled.
    DISABLED = 10

    # KmsConfig State is Migrating.
    # The existing volumes are migrating from SMEK to CMEK.
    MIGRATING = 11
  end
end