aws-sdk-secretsmanager 1.44.0 → 1.48.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -13,6 +13,7 @@ module Aws::SecretsManager
13
13
 
14
14
  include Seahorse::Model
15
15
 
16
+ AddReplicaRegionListType = Shapes::ListShape.new(name: 'AddReplicaRegionListType')
16
17
  AutomaticallyRotateAfterDaysType = Shapes::IntegerShape.new(name: 'AutomaticallyRotateAfterDaysType')
17
18
  BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
18
19
  CancelRotateSecretRequest = Shapes::StructureShape.new(name: 'CancelRotateSecretRequest')
@@ -54,6 +55,7 @@ module Aws::SecretsManager
54
55
  InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
55
56
  InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
56
57
  InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
58
+ KmsKeyIdListType = Shapes::ListShape.new(name: 'KmsKeyIdListType')
57
59
  KmsKeyIdType = Shapes::StringShape.new(name: 'KmsKeyIdType')
58
60
  LastAccessedDateType = Shapes::TimestampShape.new(name: 'LastAccessedDateType')
59
61
  LastChangedDateType = Shapes::TimestampShape.new(name: 'LastChangedDateType')
@@ -78,6 +80,15 @@ module Aws::SecretsManager
78
80
  PutSecretValueResponse = Shapes::StructureShape.new(name: 'PutSecretValueResponse')
79
81
  RandomPasswordType = Shapes::StringShape.new(name: 'RandomPasswordType')
80
82
  RecoveryWindowInDaysType = Shapes::IntegerShape.new(name: 'RecoveryWindowInDaysType')
83
+ RegionType = Shapes::StringShape.new(name: 'RegionType')
84
+ RemoveRegionsFromReplicationRequest = Shapes::StructureShape.new(name: 'RemoveRegionsFromReplicationRequest')
85
+ RemoveRegionsFromReplicationResponse = Shapes::StructureShape.new(name: 'RemoveRegionsFromReplicationResponse')
86
+ RemoveReplicaRegionListType = Shapes::ListShape.new(name: 'RemoveReplicaRegionListType')
87
+ ReplicaRegionType = Shapes::StructureShape.new(name: 'ReplicaRegionType')
88
+ ReplicateSecretToRegionsRequest = Shapes::StructureShape.new(name: 'ReplicateSecretToRegionsRequest')
89
+ ReplicateSecretToRegionsResponse = Shapes::StructureShape.new(name: 'ReplicateSecretToRegionsResponse')
90
+ ReplicationStatusListType = Shapes::ListShape.new(name: 'ReplicationStatusListType')
91
+ ReplicationStatusType = Shapes::StructureShape.new(name: 'ReplicationStatusType')
81
92
  RequireEachIncludedTypeType = Shapes::BooleanShape.new(name: 'RequireEachIncludedTypeType')
82
93
  ResourceExistsException = Shapes::StructureShape.new(name: 'ResourceExistsException')
83
94
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -102,6 +113,10 @@ module Aws::SecretsManager
102
113
  SecretVersionsListType = Shapes::ListShape.new(name: 'SecretVersionsListType')
103
114
  SecretVersionsToStagesMapType = Shapes::MapShape.new(name: 'SecretVersionsToStagesMapType')
104
115
  SortOrderType = Shapes::StringShape.new(name: 'SortOrderType')
116
+ StatusMessageType = Shapes::StringShape.new(name: 'StatusMessageType')
117
+ StatusType = Shapes::StringShape.new(name: 'StatusType')
118
+ StopReplicationToReplicaRequest = Shapes::StructureShape.new(name: 'StopReplicationToReplicaRequest')
119
+ StopReplicationToReplicaResponse = Shapes::StructureShape.new(name: 'StopReplicationToReplicaResponse')
105
120
  Tag = Shapes::StructureShape.new(name: 'Tag')
106
121
  TagKeyListType = Shapes::ListShape.new(name: 'TagKeyListType')
107
122
  TagKeyType = Shapes::StringShape.new(name: 'TagKeyType')
@@ -119,6 +134,8 @@ module Aws::SecretsManager
119
134
  ValidationErrorsEntry = Shapes::StructureShape.new(name: 'ValidationErrorsEntry')
120
135
  ValidationErrorsType = Shapes::ListShape.new(name: 'ValidationErrorsType')
121
136
 
137
+ AddReplicaRegionListType.member = Shapes::ShapeRef.new(shape: ReplicaRegionType)
138
+
122
139
  CancelRotateSecretRequest.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, required: true, location_name: "SecretId"))
123
140
  CancelRotateSecretRequest.struct_class = Types::CancelRotateSecretRequest
124
141
 
@@ -134,11 +151,14 @@ module Aws::SecretsManager
134
151
  CreateSecretRequest.add_member(:secret_binary, Shapes::ShapeRef.new(shape: SecretBinaryType, location_name: "SecretBinary"))
135
152
  CreateSecretRequest.add_member(:secret_string, Shapes::ShapeRef.new(shape: SecretStringType, location_name: "SecretString"))
136
153
  CreateSecretRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagListType, location_name: "Tags"))
154
+ CreateSecretRequest.add_member(:add_replica_regions, Shapes::ShapeRef.new(shape: AddReplicaRegionListType, location_name: "AddReplicaRegions"))
155
+ CreateSecretRequest.add_member(:force_overwrite_replica_secret, Shapes::ShapeRef.new(shape: BooleanType, location_name: "ForceOverwriteReplicaSecret"))
137
156
  CreateSecretRequest.struct_class = Types::CreateSecretRequest
138
157
 
139
158
  CreateSecretResponse.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
140
159
  CreateSecretResponse.add_member(:name, Shapes::ShapeRef.new(shape: SecretNameType, location_name: "Name"))
141
160
  CreateSecretResponse.add_member(:version_id, Shapes::ShapeRef.new(shape: SecretVersionIdType, location_name: "VersionId"))
161
+ CreateSecretResponse.add_member(:replication_status, Shapes::ShapeRef.new(shape: ReplicationStatusListType, location_name: "ReplicationStatus"))
142
162
  CreateSecretResponse.struct_class = Types::CreateSecretResponse
143
163
 
144
164
  DecryptionFailure.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
@@ -179,6 +199,8 @@ module Aws::SecretsManager
179
199
  DescribeSecretResponse.add_member(:version_ids_to_stages, Shapes::ShapeRef.new(shape: SecretVersionsToStagesMapType, location_name: "VersionIdsToStages"))
180
200
  DescribeSecretResponse.add_member(:owning_service, Shapes::ShapeRef.new(shape: OwningServiceType, location_name: "OwningService"))
181
201
  DescribeSecretResponse.add_member(:created_date, Shapes::ShapeRef.new(shape: TimestampType, location_name: "CreatedDate", metadata: {"box"=>true}))
202
+ DescribeSecretResponse.add_member(:primary_region, Shapes::ShapeRef.new(shape: RegionType, location_name: "PrimaryRegion"))
203
+ DescribeSecretResponse.add_member(:replication_status, Shapes::ShapeRef.new(shape: ReplicationStatusListType, location_name: "ReplicationStatus"))
182
204
  DescribeSecretResponse.struct_class = Types::DescribeSecretResponse
183
205
 
184
206
  EncryptionFailure.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
@@ -239,6 +261,8 @@ module Aws::SecretsManager
239
261
  InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
240
262
  InvalidRequestException.struct_class = Types::InvalidRequestException
241
263
 
264
+ KmsKeyIdListType.member = Shapes::ShapeRef.new(shape: KmsKeyIdType)
265
+
242
266
  LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
243
267
  LimitExceededException.struct_class = Types::LimitExceededException
244
268
 
@@ -295,6 +319,38 @@ module Aws::SecretsManager
295
319
  PutSecretValueResponse.add_member(:version_stages, Shapes::ShapeRef.new(shape: SecretVersionStagesType, location_name: "VersionStages"))
296
320
  PutSecretValueResponse.struct_class = Types::PutSecretValueResponse
297
321
 
322
+ RemoveRegionsFromReplicationRequest.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, required: true, location_name: "SecretId"))
323
+ RemoveRegionsFromReplicationRequest.add_member(:remove_replica_regions, Shapes::ShapeRef.new(shape: RemoveReplicaRegionListType, required: true, location_name: "RemoveReplicaRegions"))
324
+ RemoveRegionsFromReplicationRequest.struct_class = Types::RemoveRegionsFromReplicationRequest
325
+
326
+ RemoveRegionsFromReplicationResponse.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
327
+ RemoveRegionsFromReplicationResponse.add_member(:replication_status, Shapes::ShapeRef.new(shape: ReplicationStatusListType, location_name: "ReplicationStatus"))
328
+ RemoveRegionsFromReplicationResponse.struct_class = Types::RemoveRegionsFromReplicationResponse
329
+
330
+ RemoveReplicaRegionListType.member = Shapes::ShapeRef.new(shape: RegionType)
331
+
332
+ ReplicaRegionType.add_member(:region, Shapes::ShapeRef.new(shape: RegionType, location_name: "Region"))
333
+ ReplicaRegionType.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyIdType, location_name: "KmsKeyId"))
334
+ ReplicaRegionType.struct_class = Types::ReplicaRegionType
335
+
336
+ ReplicateSecretToRegionsRequest.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, required: true, location_name: "SecretId"))
337
+ ReplicateSecretToRegionsRequest.add_member(:add_replica_regions, Shapes::ShapeRef.new(shape: AddReplicaRegionListType, required: true, location_name: "AddReplicaRegions"))
338
+ ReplicateSecretToRegionsRequest.add_member(:force_overwrite_replica_secret, Shapes::ShapeRef.new(shape: BooleanType, location_name: "ForceOverwriteReplicaSecret"))
339
+ ReplicateSecretToRegionsRequest.struct_class = Types::ReplicateSecretToRegionsRequest
340
+
341
+ ReplicateSecretToRegionsResponse.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
342
+ ReplicateSecretToRegionsResponse.add_member(:replication_status, Shapes::ShapeRef.new(shape: ReplicationStatusListType, location_name: "ReplicationStatus"))
343
+ ReplicateSecretToRegionsResponse.struct_class = Types::ReplicateSecretToRegionsResponse
344
+
345
+ ReplicationStatusListType.member = Shapes::ShapeRef.new(shape: ReplicationStatusType)
346
+
347
+ ReplicationStatusType.add_member(:region, Shapes::ShapeRef.new(shape: RegionType, location_name: "Region"))
348
+ ReplicationStatusType.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyIdType, location_name: "KmsKeyId"))
349
+ ReplicationStatusType.add_member(:status, Shapes::ShapeRef.new(shape: StatusType, location_name: "Status"))
350
+ ReplicationStatusType.add_member(:status_message, Shapes::ShapeRef.new(shape: StatusMessageType, location_name: "StatusMessage"))
351
+ ReplicationStatusType.add_member(:last_accessed_date, Shapes::ShapeRef.new(shape: LastAccessedDateType, location_name: "LastAccessedDate"))
352
+ ReplicationStatusType.struct_class = Types::ReplicationStatusType
353
+
298
354
  ResourceExistsException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
299
355
  ResourceExistsException.struct_class = Types::ResourceExistsException
300
356
 
@@ -337,6 +393,7 @@ module Aws::SecretsManager
337
393
  SecretListEntry.add_member(:secret_versions_to_stages, Shapes::ShapeRef.new(shape: SecretVersionsToStagesMapType, location_name: "SecretVersionsToStages"))
338
394
  SecretListEntry.add_member(:owning_service, Shapes::ShapeRef.new(shape: OwningServiceType, location_name: "OwningService"))
339
395
  SecretListEntry.add_member(:created_date, Shapes::ShapeRef.new(shape: TimestampType, location_name: "CreatedDate", metadata: {"box"=>true}))
396
+ SecretListEntry.add_member(:primary_region, Shapes::ShapeRef.new(shape: RegionType, location_name: "PrimaryRegion"))
340
397
  SecretListEntry.struct_class = Types::SecretListEntry
341
398
 
342
399
  SecretListType.member = Shapes::ShapeRef.new(shape: SecretListEntry)
@@ -347,6 +404,7 @@ module Aws::SecretsManager
347
404
  SecretVersionsListEntry.add_member(:version_stages, Shapes::ShapeRef.new(shape: SecretVersionStagesType, location_name: "VersionStages"))
348
405
  SecretVersionsListEntry.add_member(:last_accessed_date, Shapes::ShapeRef.new(shape: LastAccessedDateType, location_name: "LastAccessedDate", metadata: {"box"=>true}))
349
406
  SecretVersionsListEntry.add_member(:created_date, Shapes::ShapeRef.new(shape: CreatedDateType, location_name: "CreatedDate", metadata: {"box"=>true}))
407
+ SecretVersionsListEntry.add_member(:kms_key_ids, Shapes::ShapeRef.new(shape: KmsKeyIdListType, location_name: "KmsKeyIds"))
350
408
  SecretVersionsListEntry.struct_class = Types::SecretVersionsListEntry
351
409
 
352
410
  SecretVersionsListType.member = Shapes::ShapeRef.new(shape: SecretVersionsListEntry)
@@ -354,6 +412,12 @@ module Aws::SecretsManager
354
412
  SecretVersionsToStagesMapType.key = Shapes::ShapeRef.new(shape: SecretVersionIdType)
355
413
  SecretVersionsToStagesMapType.value = Shapes::ShapeRef.new(shape: SecretVersionStagesType)
356
414
 
415
+ StopReplicationToReplicaRequest.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, required: true, location_name: "SecretId"))
416
+ StopReplicationToReplicaRequest.struct_class = Types::StopReplicationToReplicaRequest
417
+
418
+ StopReplicationToReplicaResponse.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
419
+ StopReplicationToReplicaResponse.struct_class = Types::StopReplicationToReplicaResponse
420
+
357
421
  Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKeyType, location_name: "Key"))
358
422
  Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValueType, location_name: "Value"))
359
423
  Tag.struct_class = Types::Tag
@@ -464,6 +528,7 @@ module Aws::SecretsManager
464
528
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
465
529
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
466
530
  o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
531
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
467
532
  end)
468
533
 
469
534
  api.add_operation(:delete_secret, Seahorse::Model::Operation.new.tap do |o|
@@ -486,6 +551,7 @@ module Aws::SecretsManager
486
551
  o.output = Shapes::ShapeRef.new(shape: DescribeSecretResponse)
487
552
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
488
553
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
554
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
489
555
  end)
490
556
 
491
557
  api.add_operation(:get_random_password, Seahorse::Model::Operation.new.tap do |o|
@@ -508,6 +574,7 @@ module Aws::SecretsManager
508
574
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
509
575
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
510
576
  o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
577
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
511
578
  end)
512
579
 
513
580
  api.add_operation(:get_secret_value, Seahorse::Model::Operation.new.tap do |o|
@@ -532,6 +599,7 @@ module Aws::SecretsManager
532
599
  o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
533
600
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
534
601
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
602
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
535
603
  o[:pager] = Aws::Pager.new(
536
604
  limit_key: "max_results",
537
605
  tokens: {
@@ -586,6 +654,30 @@ module Aws::SecretsManager
586
654
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
587
655
  end)
588
656
 
657
+ api.add_operation(:remove_regions_from_replication, Seahorse::Model::Operation.new.tap do |o|
658
+ o.name = "RemoveRegionsFromReplication"
659
+ o.http_method = "POST"
660
+ o.http_request_uri = "/"
661
+ o.input = Shapes::ShapeRef.new(shape: RemoveRegionsFromReplicationRequest)
662
+ o.output = Shapes::ShapeRef.new(shape: RemoveRegionsFromReplicationResponse)
663
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
664
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
665
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
666
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
667
+ end)
668
+
669
+ api.add_operation(:replicate_secret_to_regions, Seahorse::Model::Operation.new.tap do |o|
670
+ o.name = "ReplicateSecretToRegions"
671
+ o.http_method = "POST"
672
+ o.http_request_uri = "/"
673
+ o.input = Shapes::ShapeRef.new(shape: ReplicateSecretToRegionsRequest)
674
+ o.output = Shapes::ShapeRef.new(shape: ReplicateSecretToRegionsResponse)
675
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
676
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
677
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
678
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
679
+ end)
680
+
589
681
  api.add_operation(:restore_secret, Seahorse::Model::Operation.new.tap do |o|
590
682
  o.name = "RestoreSecret"
591
683
  o.http_method = "POST"
@@ -610,6 +702,18 @@ module Aws::SecretsManager
610
702
  o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
611
703
  end)
612
704
 
705
+ api.add_operation(:stop_replication_to_replica, Seahorse::Model::Operation.new.tap do |o|
706
+ o.name = "StopReplicationToReplica"
707
+ o.http_method = "POST"
708
+ o.http_request_uri = "/"
709
+ o.input = Shapes::ShapeRef.new(shape: StopReplicationToReplicaRequest)
710
+ o.output = Shapes::ShapeRef.new(shape: StopReplicationToReplicaResponse)
711
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
712
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
713
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
714
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
715
+ end)
716
+
613
717
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
614
718
  o.name = "TagResource"
615
719
  o.http_method = "POST"
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -96,6 +96,13 @@ module Aws::SecretsManager
96
96
  # value: "TagValueType",
97
97
  # },
98
98
  # ],
99
+ # add_replica_regions: [
100
+ # {
101
+ # region: "RegionType",
102
+ # kms_key_id: "KmsKeyIdType",
103
+ # },
104
+ # ],
105
+ # force_overwrite_replica_secret: false,
99
106
  # }
100
107
  #
101
108
  # @!attribute [rw] name
@@ -118,13 +125,14 @@ module Aws::SecretsManager
118
125
  # initial version is created as part of the secret, and this parameter
119
126
  # specifies a unique identifier for the new version.
120
127
  #
121
- # <note markdown="1"> If you use the AWS CLI or one of the AWS SDK to call this operation,
122
- # then you can leave this parameter empty. The CLI or SDK generates a
123
- # random UUID for you and includes it as the value for this parameter
124
- # in the request. If you don't use the SDK and instead generate a raw
125
- # HTTP request to the Secrets Manager service endpoint, then you must
126
- # generate a `ClientRequestToken` yourself for the new version and
127
- # include the value in the request.
128
+ # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
129
+ # Services SDK to call this operation, then you can leave this
130
+ # parameter empty. The CLI or SDK generates a random UUID for you and
131
+ # includes it as the value for this parameter in the request. If you
132
+ # don't use the SDK and instead generate a raw HTTP request to the
133
+ # Secrets Manager service endpoint, then you must generate a
134
+ # `ClientRequestToken` yourself for the new version and include the
135
+ # value in the request.
128
136
  #
129
137
  # </note>
130
138
  #
@@ -143,8 +151,8 @@ module Aws::SecretsManager
143
151
  #
144
152
  # * If a version with this value already exists and that version's
145
153
  # `SecretString` and `SecretBinary` values are different from those
146
- # in the request then the request fails because you cannot modify an
147
- # existing version. Instead, use PutSecretValue to create a new
154
+ # in the request, then the request fails because you cannot modify
155
+ # an existing version. Instead, use PutSecretValue to create a new
148
156
  # version.
149
157
  #
150
158
  # This value becomes the `VersionId` of the new version.
@@ -162,20 +170,21 @@ module Aws::SecretsManager
162
170
  # @return [String]
163
171
  #
164
172
  # @!attribute [rw] kms_key_id
165
- # (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS
166
- # customer master key (CMK) to be used to encrypt the `SecretString`
167
- # or `SecretBinary` values in the versions stored in this secret.
173
+ # (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web
174
+ # Services KMS customer master key (CMK) to be used to encrypt the
175
+ # `SecretString` or `SecretBinary` values in the versions stored in
176
+ # this secret.
168
177
  #
169
- # You can specify any of the supported ways to identify a AWS KMS key
170
- # ID. If you need to reference a CMK in a different account, you can
171
- # use only the key ARN or the alias ARN.
178
+ # You can specify any of the supported ways to identify a Amazon Web
179
+ # Services KMS key ID. If you need to reference a CMK in a different
180
+ # account, you can use only the key ARN or the alias ARN.
172
181
  #
173
182
  # If you don't specify this value, then Secrets Manager defaults to
174
- # using the AWS account's default CMK (the one named
175
- # `aws/secretsmanager`). If a AWS KMS CMK with that name doesn't yet
176
- # exist, then Secrets Manager creates it for you automatically the
177
- # first time it needs to encrypt a version's `SecretString` or
178
- # `SecretBinary` fields.
183
+ # using the Amazon Web Services account's default CMK (the one named
184
+ # `aws/secretsmanager`). If a Amazon Web Services KMS CMK with that
185
+ # name doesn't yet exist, then Secrets Manager creates it for you
186
+ # automatically the first time it needs to encrypt a version's
187
+ # `SecretString` or `SecretBinary` fields.
179
188
  #
180
189
  # You can use the account default CMK to encrypt and decrypt only if
181
190
  # you call this operation using credentials from the same account that
@@ -194,7 +203,8 @@ module Aws::SecretsManager
194
203
  # both. They cannot both be empty.
195
204
  #
196
205
  # This parameter is not available using the Secrets Manager console.
197
- # It can be accessed only by using the AWS CLI or one of the AWS SDKs.
206
+ # It can be accessed only by using the Amazon Web Services CLI or one
207
+ # of the Amazon Web Services SDKs.
198
208
  # @return [String]
199
209
  #
200
210
  # @!attribute [rw] secret_string
@@ -213,8 +223,8 @@ module Aws::SecretsManager
213
223
  # For storing multiple values, we recommend that you use a JSON text
214
224
  # string argument and specify key/value pairs. For information on how
215
225
  # to format a JSON parameter for the various command line tool
216
- # environments, see [Using JSON for Parameters][1] in the *AWS CLI
217
- # User Guide*. For example:
226
+ # environments, see [Using JSON for Parameters][1] in the *CLI User
227
+ # Guide*. For example:
218
228
  #
219
229
  # `\{"username":"bob","password":"abc123xyz456"\}`
220
230
  #
@@ -244,8 +254,8 @@ module Aws::SecretsManager
244
254
  #
245
255
  # This parameter requires a JSON text string argument. For information
246
256
  # on how to format a JSON parameter for the various command line tool
247
- # environments, see [Using JSON for Parameters][1] in the *AWS CLI
248
- # User Guide*. For example:
257
+ # environments, see [Using JSON for Parameters][1] in the *CLI User
258
+ # Guide*. For example:
249
259
  #
250
260
  # `[\{"Key":"CostCenter","Value":"12345"\},\{"Key":"environment","Value":"production"\}]`
251
261
  #
@@ -264,9 +274,9 @@ module Aws::SecretsManager
264
274
  # * Tag keys and values are case sensitive.
265
275
  #
266
276
  # * Do not use the `aws:` prefix in your tag names or values because
267
- # AWS reserves it for AWS use. You can't edit or delete tag names
268
- # or values with this prefix. Tags with this prefix do not count
269
- # against your tags per secret limit.
277
+ # Amazon Web Services reserves it for Amazon Web Services use. You
278
+ # can't edit or delete tag names or values with this prefix. Tags
279
+ # with this prefix do not count against your tags per secret limit.
270
280
  #
271
281
  # * If you use your tagging schema across multiple services and
272
282
  # resources, remember other services might have restrictions on
@@ -279,6 +289,17 @@ module Aws::SecretsManager
279
289
  # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
280
290
  # @return [Array<Types::Tag>]
281
291
  #
292
+ # @!attribute [rw] add_replica_regions
293
+ # (Optional) Add a list of regions to replicate secrets. Secrets
294
+ # Manager replicates the KMSKeyID objects to the list of regions
295
+ # specified in the parameter.
296
+ # @return [Array<Types::ReplicaRegionType>]
297
+ #
298
+ # @!attribute [rw] force_overwrite_replica_secret
299
+ # (Optional) If set, the replication overwrites a secret with the same
300
+ # name in the destination region.
301
+ # @return [Boolean]
302
+ #
282
303
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecretRequest AWS API Documentation
283
304
  #
284
305
  class CreateSecretRequest < Struct.new(
@@ -288,7 +309,9 @@ module Aws::SecretsManager
288
309
  :kms_key_id,
289
310
  :secret_binary,
290
311
  :secret_string,
291
- :tags)
312
+ :tags,
313
+ :add_replica_regions,
314
+ :force_overwrite_replica_secret)
292
315
  SENSITIVE = [:secret_binary, :secret_string]
293
316
  include Aws::Structure
294
317
  end
@@ -316,12 +339,18 @@ module Aws::SecretsManager
316
339
  # just created.
317
340
  # @return [String]
318
341
  #
342
+ # @!attribute [rw] replication_status
343
+ # Describes a list of replication status objects as `InProgress`,
344
+ # `Failed` or `InSync`.
345
+ # @return [Array<Types::ReplicationStatusType>]
346
+ #
319
347
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecretResponse AWS API Documentation
320
348
  #
321
349
  class CreateSecretResponse < Struct.new(
322
350
  :arn,
323
351
  :name,
324
- :version_id)
352
+ :version_id,
353
+ :replication_status)
325
354
  SENSITIVE = []
326
355
  include Aws::Structure
327
356
  end
@@ -412,8 +441,8 @@ module Aws::SecretsManager
412
441
  # }
413
442
  #
414
443
  # @!attribute [rw] secret_id
415
- # Specifies the secret that you want to delete. You can specify either
416
- # the Amazon Resource Name (ARN) or the friendly name of the secret.
444
+ # Specifies the secret to delete. You can specify either the Amazon
445
+ # Resource Name (ARN) or the friendly name of the secret.
417
446
  #
418
447
  # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
419
448
  # complete ARN. You can specify a partial ARN too—for example, if you
@@ -440,10 +469,11 @@ module Aws::SecretsManager
440
469
  #
441
470
  # @!attribute [rw] recovery_window_in_days
442
471
  # (Optional) Specifies the number of days that Secrets Manager waits
443
- # before it can delete the secret. You can't use both this parameter
444
- # and the `ForceDeleteWithoutRecovery` parameter in the same API call.
472
+ # before Secrets Manager can delete the secret. You can't use both
473
+ # this parameter and the `ForceDeleteWithoutRecovery` parameter in the
474
+ # same API call.
445
475
  #
446
- # This value can range from 7 to 30 days. The default value is 30.
476
+ # This value can range from 7 to 30 days with a default value of 30.
447
477
  # @return [Integer]
448
478
  #
449
479
  # @!attribute [rw] force_delete_without_recovery
@@ -459,10 +489,14 @@ module Aws::SecretsManager
459
489
  #
460
490
  # Use this parameter with caution. This parameter causes the operation
461
491
  # to skip the normal waiting period before the permanent deletion that
462
- # AWS would normally impose with the `RecoveryWindowInDays` parameter.
463
- # If you delete a secret with the `ForceDeleteWithouRecovery`
464
- # parameter, then you have no opportunity to recover the secret. It is
465
- # permanently lost.
492
+ # Amazon Web Services would normally impose with the
493
+ # `RecoveryWindowInDays` parameter. If you delete a secret with the
494
+ # `ForceDeleteWithouRecovery` parameter, then you have no opportunity
495
+ # to recover the secret. You lose the secret permanently.
496
+ #
497
+ # If you use this parameter and include a previously deleted or
498
+ # nonexistent secret, the operation does not return the error
499
+ # `ResourceNotFoundException` in order to correctly handle retries.
466
500
  # @return [Boolean]
467
501
  #
468
502
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteSecretRequest AWS API Documentation
@@ -480,7 +514,7 @@ module Aws::SecretsManager
480
514
  # @return [String]
481
515
  #
482
516
  # @!attribute [rw] name
483
- # The friendly name of the secret that is now scheduled for deletion.
517
+ # The friendly name of the secret currently scheduled for deletion.
484
518
  # @return [String]
485
519
  #
486
520
  # @!attribute [rw] deletion_date
@@ -556,11 +590,12 @@ module Aws::SecretsManager
556
590
  # @return [String]
557
591
  #
558
592
  # @!attribute [rw] kms_key_id
559
- # The ARN or alias of the AWS KMS customer master key (CMK) that's
560
- # used to encrypt the `SecretString` or `SecretBinary` fields in each
561
- # version of the secret. If you don't provide a key, then Secrets
562
- # Manager defaults to encrypting the secret fields with the default
563
- # AWS KMS CMK (the one named `awssecretsmanager`) for this account.
593
+ # The ARN or alias of the Amazon Web Services KMS customer master key
594
+ # (CMK) that's used to encrypt the `SecretString` or `SecretBinary`
595
+ # fields in each version of the secret. If you don't provide a key,
596
+ # then Secrets Manager defaults to encrypting the secret fields with
597
+ # the default Amazon Web Services KMS CMK (the one named
598
+ # `awssecretsmanager`) for this account.
564
599
  # @return [String]
565
600
  #
566
601
  # @!attribute [rw] rotation_enabled
@@ -578,14 +613,16 @@ module Aws::SecretsManager
578
613
  # @return [String]
579
614
  #
580
615
  # @!attribute [rw] rotation_rules
581
- # A structure that contains the rotation configuration for this
582
- # secret.
616
+ # A structure with the rotation configuration for this secret.
583
617
  # @return [Types::RotationRulesType]
584
618
  #
585
619
  # @!attribute [rw] last_rotated_date
620
+ # The last date and time that the rotation process for this secret was
621
+ # invoked.
622
+ #
586
623
  # The most recent date and time that the Secrets Manager rotation
587
- # process was successfully completed. This value is null if the secret
588
- # has never rotated.
624
+ # process successfully completed. If the secret doesn't rotate,
625
+ # Secrets Manager returns a null value.
589
626
  # @return [Time]
590
627
  #
591
628
  # @!attribute [rw] last_changed_date
@@ -632,9 +669,18 @@ module Aws::SecretsManager
632
669
  # @return [String]
633
670
  #
634
671
  # @!attribute [rw] created_date
635
- # The date that the secret was created.
672
+ # The date you created the secret.
636
673
  # @return [Time]
637
674
  #
675
+ # @!attribute [rw] primary_region
676
+ # Specifies the primary region for secret replication.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] replication_status
680
+ # Describes a list of replication status objects as `InProgress`,
681
+ # `Failed` or `InSync`.`P`
682
+ # @return [Array<Types::ReplicationStatusType>]
683
+ #
638
684
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretResponse AWS API Documentation
639
685
  #
640
686
  class DescribeSecretResponse < Struct.new(
@@ -652,7 +698,9 @@ module Aws::SecretsManager
652
698
  :tags,
653
699
  :version_ids_to_stages,
654
700
  :owning_service,
655
- :created_date)
701
+ :created_date,
702
+ :primary_region,
703
+ :replication_status)
656
704
  SENSITIVE = []
657
705
  include Aws::Structure
658
706
  end
@@ -677,13 +725,14 @@ module Aws::SecretsManager
677
725
  include Aws::Structure
678
726
  end
679
727
 
680
- # Allows you to filter your list of secrets.
728
+ # Allows you to add filters when you use the search function in Secrets
729
+ # Manager.
681
730
  #
682
731
  # @note When making an API call, you may pass Filter
683
732
  # data as a hash:
684
733
  #
685
734
  # {
686
- # key: "description", # accepts description, name, tag-key, tag-value, all
735
+ # key: "description", # accepts description, name, tag-key, tag-value, primary-region, all
687
736
  # values: ["FilterValueStringType"],
688
737
  # }
689
738
  #
@@ -693,6 +742,9 @@ module Aws::SecretsManager
693
742
  #
694
743
  # @!attribute [rw] values
695
744
  # Filters your list of secrets by a specific value.
745
+ #
746
+ # You can prefix your search value with an exclamation mark (`!`) in
747
+ # order to perform negation filters.
696
748
  # @return [Array<String>]
697
749
  #
698
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/Filter AWS API Documentation
@@ -859,8 +911,9 @@ module Aws::SecretsManager
859
911
  # with any permissions that are associated with the user or role that
860
912
  # attempts to access this secret. The combined permissions specify who
861
913
  # can access the secret and what actions they can perform. For more
862
- # information, see [Authentication and Access Control for AWS Secrets
863
- # Manager][1] in the *AWS Secrets Manager User Guide*.
914
+ # information, see [Authentication and Access Control for Amazon Web
915
+ # Services Secrets Manager][1] in the *Amazon Web Services Secrets
916
+ # Manager User Guide*.
864
917
  #
865
918
  #
866
919
  #
@@ -916,11 +969,11 @@ module Aws::SecretsManager
916
969
  #
917
970
  # @!attribute [rw] version_id
918
971
  # Specifies the unique identifier of the version of the secret that
919
- # you want to retrieve. If you specify this parameter then don't
920
- # specify `VersionStage`. If you don't specify either a
921
- # `VersionStage` or `VersionId` then the default is to perform the
922
- # operation on the version with the `VersionStage` value of
923
- # `AWSCURRENT`.
972
+ # you want to retrieve. If you specify both this parameter and
973
+ # `VersionStage`, the two parameters must refer to the same secret
974
+ # version. If you don't specify either a `VersionStage` or
975
+ # `VersionId` then the default is to perform the operation on the
976
+ # version with the `VersionStage` value of `AWSCURRENT`.
924
977
  #
925
978
  # This value is typically a [UUID-type][1] value with 32 hexadecimal
926
979
  # digits.
@@ -935,8 +988,9 @@ module Aws::SecretsManager
935
988
  # staging label attached to the version.
936
989
  #
937
990
  # Staging labels are used to keep track of different versions during
938
- # the rotation process. If you use this parameter then don't specify
939
- # `VersionId`. If you don't specify either a `VersionStage` or
991
+ # the rotation process. If you specify both this parameter and
992
+ # `VersionId`, the two parameters must refer to the same secret
993
+ # version . If you don't specify either a `VersionStage` or
940
994
  # `VersionId`, then the default is to perform the operation on the
941
995
  # version with the `VersionStage` value of `AWSCURRENT`.
942
996
  # @return [String]
@@ -1226,7 +1280,7 @@ module Aws::SecretsManager
1226
1280
  # next_token: "NextTokenType",
1227
1281
  # filters: [
1228
1282
  # {
1229
- # key: "description", # accepts description, name, tag-key, tag-value, all
1283
+ # key: "description", # accepts description, name, tag-key, tag-value, primary-region, all
1230
1284
  # values: ["FilterValueStringType"],
1231
1285
  # },
1232
1286
  # ],
@@ -1297,7 +1351,7 @@ module Aws::SecretsManager
1297
1351
  include Aws::Structure
1298
1352
  end
1299
1353
 
1300
- # The policy document that you provided isn't valid.
1354
+ # You provided a resource-based policy with syntax errors.
1301
1355
  #
1302
1356
  # @!attribute [rw] message
1303
1357
  # @return [String]
@@ -1324,7 +1378,8 @@ module Aws::SecretsManager
1324
1378
  include Aws::Structure
1325
1379
  end
1326
1380
 
1327
- # The resource policy did not prevent broad access to the secret.
1381
+ # The BlockPublicPolicy parameter is set to true and the resource policy
1382
+ # did not prevent broad access to the secret.
1328
1383
  #
1329
1384
  # @!attribute [rw] message
1330
1385
  # @return [String]
@@ -1348,8 +1403,8 @@ module Aws::SecretsManager
1348
1403
  #
1349
1404
  # @!attribute [rw] secret_id
1350
1405
  # Specifies the secret that you want to attach the resource-based
1351
- # policy to. You can specify either the ARN or the friendly name of
1352
- # the secret.
1406
+ # policy. You can specify either the ARN or the friendly name of the
1407
+ # secret.
1353
1408
  #
1354
1409
  # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1355
1410
  # complete ARN. You can specify a partial ARN too—for example, if you
@@ -1375,12 +1430,12 @@ module Aws::SecretsManager
1375
1430
  # @return [String]
1376
1431
  #
1377
1432
  # @!attribute [rw] resource_policy
1378
- # A JSON-formatted string that's constructed according to the grammar
1379
- # and syntax for an AWS resource-based policy. The policy in the
1380
- # string identifies who can access or manage this secret and its
1381
- # versions. For information on how to format a JSON parameter for the
1382
- # various command line tool environments, see [Using JSON for
1383
- # Parameters][1] in the *AWS CLI User Guide*.
1433
+ # A JSON-formatted string constructed according to the grammar and
1434
+ # syntax for an Amazon Web Services resource-based policy. The policy
1435
+ # in the string identifies who can access or manage this secret and
1436
+ # its versions. For information on how to format a JSON parameter for
1437
+ # the various command line tool environments, see [Using JSON for
1438
+ # Parameters][1] in the *CLI User Guide*.
1384
1439
  #
1385
1440
  #
1386
1441
  #
@@ -1388,8 +1443,9 @@ module Aws::SecretsManager
1388
1443
  # @return [String]
1389
1444
  #
1390
1445
  # @!attribute [rw] block_public_policy
1391
- # Makes an optional API call to Zelkova to validate the Resource
1392
- # Policy to prevent broad access to your secret.
1446
+ # (Optional) If you set the parameter, `BlockPublicPolicy` to true,
1447
+ # then you block resource-based policies that allow broad access to
1448
+ # the secret.
1393
1449
  # @return [Boolean]
1394
1450
  #
1395
1451
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyRequest AWS API Documentation
@@ -1407,8 +1463,8 @@ module Aws::SecretsManager
1407
1463
  # @return [String]
1408
1464
  #
1409
1465
  # @!attribute [rw] name
1410
- # The friendly name of the secret that the retrieved by the
1411
- # resource-based policy.
1466
+ # The friendly name of the secret retrieved by the resource-based
1467
+ # policy.
1412
1468
  # @return [String]
1413
1469
  #
1414
1470
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyResponse AWS API Documentation
@@ -1463,13 +1519,13 @@ module Aws::SecretsManager
1463
1519
  # (Optional) Specifies a unique identifier for the new version of the
1464
1520
  # secret.
1465
1521
  #
1466
- # <note markdown="1"> If you use the AWS CLI or one of the AWS SDK to call this operation,
1467
- # then you can leave this parameter empty. The CLI or SDK generates a
1468
- # random UUID for you and includes that in the request. If you don't
1469
- # use the SDK and instead generate a raw HTTP request to the Secrets
1470
- # Manager service endpoint, then you must generate a
1471
- # `ClientRequestToken` yourself for new versions and include that
1472
- # value in the request.
1522
+ # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
1523
+ # Services SDK to call this operation, then you can leave this
1524
+ # parameter empty. The CLI or SDK generates a random UUID for you and
1525
+ # includes that in the request. If you don't use the SDK and instead
1526
+ # generate a raw HTTP request to the Secrets Manager service endpoint,
1527
+ # then you must generate a `ClientRequestToken` yourself for new
1528
+ # versions and include that value in the request.
1473
1529
  #
1474
1530
  # </note>
1475
1531
  #
@@ -1531,8 +1587,8 @@ module Aws::SecretsManager
1531
1587
  # For storing multiple values, we recommend that you use a JSON text
1532
1588
  # string argument and specify key/value pairs. For information on how
1533
1589
  # to format a JSON parameter for the various command line tool
1534
- # environments, see [Using JSON for Parameters][1] in the *AWS CLI
1535
- # User Guide*.
1590
+ # environments, see [Using JSON for Parameters][1] in the *CLI User
1591
+ # Guide*.
1536
1592
  #
1537
1593
  # For example:
1538
1594
  #
@@ -1608,6 +1664,170 @@ module Aws::SecretsManager
1608
1664
  include Aws::Structure
1609
1665
  end
1610
1666
 
1667
+ # @note When making an API call, you may pass RemoveRegionsFromReplicationRequest
1668
+ # data as a hash:
1669
+ #
1670
+ # {
1671
+ # secret_id: "SecretIdType", # required
1672
+ # remove_replica_regions: ["RegionType"], # required
1673
+ # }
1674
+ #
1675
+ # @!attribute [rw] secret_id
1676
+ # Remove a secret by `SecretId` from replica Regions.
1677
+ # @return [String]
1678
+ #
1679
+ # @!attribute [rw] remove_replica_regions
1680
+ # Remove replication from specific Regions.
1681
+ # @return [Array<String>]
1682
+ #
1683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RemoveRegionsFromReplicationRequest AWS API Documentation
1684
+ #
1685
+ class RemoveRegionsFromReplicationRequest < Struct.new(
1686
+ :secret_id,
1687
+ :remove_replica_regions)
1688
+ SENSITIVE = []
1689
+ include Aws::Structure
1690
+ end
1691
+
1692
+ # @!attribute [rw] arn
1693
+ # The secret `ARN` removed from replication regions.
1694
+ # @return [String]
1695
+ #
1696
+ # @!attribute [rw] replication_status
1697
+ # Describes the remaining replication status after you remove regions
1698
+ # from the replication list.
1699
+ # @return [Array<Types::ReplicationStatusType>]
1700
+ #
1701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RemoveRegionsFromReplicationResponse AWS API Documentation
1702
+ #
1703
+ class RemoveRegionsFromReplicationResponse < Struct.new(
1704
+ :arn,
1705
+ :replication_status)
1706
+ SENSITIVE = []
1707
+ include Aws::Structure
1708
+ end
1709
+
1710
+ # (Optional) Custom type consisting of a `Region` (required) and the
1711
+ # `KmsKeyId` which can be an `ARN`, `Key ID`, or `Alias`.
1712
+ #
1713
+ # @note When making an API call, you may pass ReplicaRegionType
1714
+ # data as a hash:
1715
+ #
1716
+ # {
1717
+ # region: "RegionType",
1718
+ # kms_key_id: "KmsKeyIdType",
1719
+ # }
1720
+ #
1721
+ # @!attribute [rw] region
1722
+ # Describes a single instance of Region objects.
1723
+ # @return [String]
1724
+ #
1725
+ # @!attribute [rw] kms_key_id
1726
+ # Can be an `ARN`, `Key ID`, or `Alias`.
1727
+ # @return [String]
1728
+ #
1729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicaRegionType AWS API Documentation
1730
+ #
1731
+ class ReplicaRegionType < Struct.new(
1732
+ :region,
1733
+ :kms_key_id)
1734
+ SENSITIVE = []
1735
+ include Aws::Structure
1736
+ end
1737
+
1738
+ # @note When making an API call, you may pass ReplicateSecretToRegionsRequest
1739
+ # data as a hash:
1740
+ #
1741
+ # {
1742
+ # secret_id: "SecretIdType", # required
1743
+ # add_replica_regions: [ # required
1744
+ # {
1745
+ # region: "RegionType",
1746
+ # kms_key_id: "KmsKeyIdType",
1747
+ # },
1748
+ # ],
1749
+ # force_overwrite_replica_secret: false,
1750
+ # }
1751
+ #
1752
+ # @!attribute [rw] secret_id
1753
+ # Use the `Secret Id` to replicate a secret to regions.
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] add_replica_regions
1757
+ # Add Regions to replicate the secret.
1758
+ # @return [Array<Types::ReplicaRegionType>]
1759
+ #
1760
+ # @!attribute [rw] force_overwrite_replica_secret
1761
+ # (Optional) If set, Secrets Manager replication overwrites a secret
1762
+ # with the same name in the destination region.
1763
+ # @return [Boolean]
1764
+ #
1765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicateSecretToRegionsRequest AWS API Documentation
1766
+ #
1767
+ class ReplicateSecretToRegionsRequest < Struct.new(
1768
+ :secret_id,
1769
+ :add_replica_regions,
1770
+ :force_overwrite_replica_secret)
1771
+ SENSITIVE = []
1772
+ include Aws::Structure
1773
+ end
1774
+
1775
+ # @!attribute [rw] arn
1776
+ # Replicate a secret based on the `ReplicaRegionType`&gt; consisting
1777
+ # of a Region(required) and a KMSKeyId (optional) which can be the
1778
+ # ARN, KeyID, or Alias.
1779
+ # @return [String]
1780
+ #
1781
+ # @!attribute [rw] replication_status
1782
+ # Describes the secret replication status as `PENDING`, `SUCCESS` or
1783
+ # `FAIL`.
1784
+ # @return [Array<Types::ReplicationStatusType>]
1785
+ #
1786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicateSecretToRegionsResponse AWS API Documentation
1787
+ #
1788
+ class ReplicateSecretToRegionsResponse < Struct.new(
1789
+ :arn,
1790
+ :replication_status)
1791
+ SENSITIVE = []
1792
+ include Aws::Structure
1793
+ end
1794
+
1795
+ # A replication object consisting of a `RegionReplicationStatus` object
1796
+ # and includes a Region, KMSKeyId, status, and status message.
1797
+ #
1798
+ # @!attribute [rw] region
1799
+ # The Region where replication occurs.
1800
+ # @return [String]
1801
+ #
1802
+ # @!attribute [rw] kms_key_id
1803
+ # Can be an `ARN`, `Key ID`, or `Alias`.
1804
+ # @return [String]
1805
+ #
1806
+ # @!attribute [rw] status
1807
+ # The status can be `InProgress`, `Failed`, or `InSync`.
1808
+ # @return [String]
1809
+ #
1810
+ # @!attribute [rw] status_message
1811
+ # Status message such as "*Secret with this name already exists in
1812
+ # this region*".
1813
+ # @return [String]
1814
+ #
1815
+ # @!attribute [rw] last_accessed_date
1816
+ # The date that you last accessed the secret in the Region.
1817
+ # @return [Time]
1818
+ #
1819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicationStatusType AWS API Documentation
1820
+ #
1821
+ class ReplicationStatusType < Struct.new(
1822
+ :region,
1823
+ :kms_key_id,
1824
+ :status,
1825
+ :status_message,
1826
+ :last_accessed_date)
1827
+ SENSITIVE = []
1828
+ include Aws::Structure
1829
+ end
1830
+
1611
1831
  # A resource with the ID you requested already exists.
1612
1832
  #
1613
1833
  # @!attribute [rw] message
@@ -1737,13 +1957,14 @@ module Aws::SecretsManager
1737
1957
  # (Optional) Specifies a unique identifier for the new version of the
1738
1958
  # secret that helps ensure idempotency.
1739
1959
  #
1740
- # If you use the AWS CLI or one of the AWS SDK to call this operation,
1741
- # then you can leave this parameter empty. The CLI or SDK generates a
1742
- # random UUID for you and includes that in the request for this
1743
- # parameter. If you don't use the SDK and instead generate a raw HTTP
1744
- # request to the Secrets Manager service endpoint, then you must
1745
- # generate a `ClientRequestToken` yourself for new versions and
1746
- # include that value in the request.
1960
+ # If you use the Amazon Web Services CLI or one of the Amazon Web
1961
+ # Services SDK to call this operation, then you can leave this
1962
+ # parameter empty. The CLI or SDK generates a random UUID for you and
1963
+ # includes that in the request for this parameter. If you don't use
1964
+ # the SDK and instead generate a raw HTTP request to the Secrets
1965
+ # Manager service endpoint, then you must generate a
1966
+ # `ClientRequestToken` yourself for new versions and include that
1967
+ # value in the request.
1747
1968
  #
1748
1969
  # You only need to specify your own value if you implement your own
1749
1970
  # retry logic and want to ensure that a given secret is not created
@@ -1844,7 +2065,8 @@ module Aws::SecretsManager
1844
2065
  # The Amazon Resource Name (ARN) of the secret.
1845
2066
  #
1846
2067
  # For more information about ARNs in Secrets Manager, see [Policy
1847
- # Resources][1] in the *AWS Secrets Manager User Guide*.
2068
+ # Resources][1] in the *Amazon Web Services Secrets Manager User
2069
+ # Guide*.
1848
2070
  #
1849
2071
  #
1850
2072
  #
@@ -1863,11 +2085,12 @@ module Aws::SecretsManager
1863
2085
  # @return [String]
1864
2086
  #
1865
2087
  # @!attribute [rw] kms_key_id
1866
- # The ARN or alias of the AWS KMS customer master key (CMK) used to
1867
- # encrypt the `SecretString` and `SecretBinary` fields in each version
1868
- # of the secret. If you don't provide a key, then Secrets Manager
1869
- # defaults to encrypting the secret fields with the default KMS CMK,
1870
- # the key named `awssecretsmanager`, for this account.
2088
+ # The ARN or alias of the Amazon Web Services KMS customer master key
2089
+ # (CMK) used to encrypt the `SecretString` and `SecretBinary` fields
2090
+ # in each version of the secret. If you don't provide a key, then
2091
+ # Secrets Manager defaults to encrypting the secret fields with the
2092
+ # default KMS CMK, the key named `awssecretsmanager`, for this
2093
+ # account.
1871
2094
  # @return [String]
1872
2095
  #
1873
2096
  # @!attribute [rw] rotation_enabled
@@ -1876,9 +2099,9 @@ module Aws::SecretsManager
1876
2099
  # @return [Boolean]
1877
2100
  #
1878
2101
  # @!attribute [rw] rotation_lambda_arn
1879
- # The ARN of an AWS Lambda function invoked by Secrets Manager to
1880
- # rotate and expire the secret either automatically per the schedule
1881
- # or manually by a call to RotateSecret.
2102
+ # The ARN of an Amazon Web Services Lambda function invoked by Secrets
2103
+ # Manager to rotate and expire the secret either automatically per the
2104
+ # schedule or manually by a call to RotateSecret.
1882
2105
  # @return [String]
1883
2106
  #
1884
2107
  # @!attribute [rw] rotation_rules
@@ -1886,8 +2109,9 @@ module Aws::SecretsManager
1886
2109
  # @return [Types::RotationRulesType]
1887
2110
  #
1888
2111
  # @!attribute [rw] last_rotated_date
1889
- # The last date and time that the rotation process for this secret was
1890
- # invoked.
2112
+ # The most recent date and time that the Secrets Manager rotation
2113
+ # process was successfully completed. This value is null if the secret
2114
+ # hasn't ever rotated.
1891
2115
  # @return [Time]
1892
2116
  #
1893
2117
  # @!attribute [rw] last_changed_date
@@ -1934,6 +2158,10 @@ module Aws::SecretsManager
1934
2158
  # The date and time when a secret was created.
1935
2159
  # @return [Time]
1936
2160
  #
2161
+ # @!attribute [rw] primary_region
2162
+ # The Region where Secrets Manager originated the secret.
2163
+ # @return [String]
2164
+ #
1937
2165
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/SecretListEntry AWS API Documentation
1938
2166
  #
1939
2167
  class SecretListEntry < Struct.new(
@@ -1951,7 +2179,8 @@ module Aws::SecretsManager
1951
2179
  :tags,
1952
2180
  :secret_versions_to_stages,
1953
2181
  :owning_service,
1954
- :created_date)
2182
+ :created_date,
2183
+ :primary_region)
1955
2184
  SENSITIVE = []
1956
2185
  include Aws::Structure
1957
2186
  end
@@ -1977,13 +2206,51 @@ module Aws::SecretsManager
1977
2206
  # The date and time this version of the secret was created.
1978
2207
  # @return [Time]
1979
2208
  #
2209
+ # @!attribute [rw] kms_key_ids
2210
+ # The KMS keys used to encrypt the secret version.
2211
+ # @return [Array<String>]
2212
+ #
1980
2213
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/SecretVersionsListEntry AWS API Documentation
1981
2214
  #
1982
2215
  class SecretVersionsListEntry < Struct.new(
1983
2216
  :version_id,
1984
2217
  :version_stages,
1985
2218
  :last_accessed_date,
1986
- :created_date)
2219
+ :created_date,
2220
+ :kms_key_ids)
2221
+ SENSITIVE = []
2222
+ include Aws::Structure
2223
+ end
2224
+
2225
+ # @note When making an API call, you may pass StopReplicationToReplicaRequest
2226
+ # data as a hash:
2227
+ #
2228
+ # {
2229
+ # secret_id: "SecretIdType", # required
2230
+ # }
2231
+ #
2232
+ # @!attribute [rw] secret_id
2233
+ # Response to `StopReplicationToReplica` of a secret, based on the
2234
+ # `SecretId`.
2235
+ # @return [String]
2236
+ #
2237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/StopReplicationToReplicaRequest AWS API Documentation
2238
+ #
2239
+ class StopReplicationToReplicaRequest < Struct.new(
2240
+ :secret_id)
2241
+ SENSITIVE = []
2242
+ include Aws::Structure
2243
+ end
2244
+
2245
+ # @!attribute [rw] arn
2246
+ # Response `StopReplicationToReplica` of a secret, based on the
2247
+ # `ARN,`.
2248
+ # @return [String]
2249
+ #
2250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/StopReplicationToReplicaResponse AWS API Documentation
2251
+ #
2252
+ class StopReplicationToReplicaResponse < Struct.new(
2253
+ :arn)
1987
2254
  SENSITIVE = []
1988
2255
  include Aws::Structure
1989
2256
  end
@@ -2063,9 +2330,8 @@ module Aws::SecretsManager
2063
2330
  # This parameter to the API requires a JSON text string argument. For
2064
2331
  # information on how to format a JSON parameter for the various
2065
2332
  # command line tool environments, see [Using JSON for Parameters][1]
2066
- # in the *AWS CLI User Guide*. For the AWS CLI, you can also use the
2067
- # syntax: `--Tags
2068
- # Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…]`
2333
+ # in the *CLI User Guide*. For the CLI, you can also use the syntax:
2334
+ # `--Tags Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]`
2069
2335
  #
2070
2336
  #
2071
2337
  #
@@ -2125,7 +2391,7 @@ module Aws::SecretsManager
2125
2391
  # This parameter to the API requires a JSON text string argument. For
2126
2392
  # information on how to format a JSON parameter for the various
2127
2393
  # command line tool environments, see [Using JSON for Parameters][1]
2128
- # in the *AWS CLI User Guide*.
2394
+ # in the *CLI User Guide*.
2129
2395
  #
2130
2396
  #
2131
2397
  #
@@ -2186,13 +2452,13 @@ module Aws::SecretsManager
2186
2452
  # parameter specifies a unique identifier for the new version that
2187
2453
  # helps ensure idempotency.
2188
2454
  #
2189
- # If you use the AWS CLI or one of the AWS SDK to call this operation,
2190
- # then you can leave this parameter empty. The CLI or SDK generates a
2191
- # random UUID for you and includes that in the request. If you don't
2192
- # use the SDK and instead generate a raw HTTP request to the Secrets
2193
- # Manager service endpoint, then you must generate a
2194
- # `ClientRequestToken` yourself for new versions and include that
2195
- # value in the request.
2455
+ # If you use the Amazon Web Services CLI or one of the Amazon Web
2456
+ # Services SDK to call this operation, then you can leave this
2457
+ # parameter empty. The CLI or SDK generates a random UUID for you and
2458
+ # includes that in the request. If you don't use the SDK and instead
2459
+ # generate a raw HTTP request to the Secrets Manager service endpoint,
2460
+ # then you must generate a `ClientRequestToken` yourself for new
2461
+ # versions and include that value in the request.
2196
2462
  #
2197
2463
  # You typically only need to interact with this value if you implement
2198
2464
  # your own retry logic and want to ensure that a given secret is not
@@ -2232,9 +2498,9 @@ module Aws::SecretsManager
2232
2498
  # @return [String]
2233
2499
  #
2234
2500
  # @!attribute [rw] kms_key_id
2235
- # (Optional) Specifies an updated ARN or alias of the AWS KMS customer
2236
- # master key (CMK) to be used to encrypt the protected text in new
2237
- # versions of this secret.
2501
+ # (Optional) Specifies an updated ARN or alias of the Amazon Web
2502
+ # Services KMS customer master key (CMK) to be used to encrypt the
2503
+ # protected text in new versions of this secret.
2238
2504
  #
2239
2505
  # You can only use the account's default CMK to encrypt and decrypt
2240
2506
  # if you call this operation using credentials from the same account
@@ -2271,8 +2537,8 @@ module Aws::SecretsManager
2271
2537
  # For storing multiple values, we recommend that you use a JSON text
2272
2538
  # string argument and specify key/value pairs. For information on how
2273
2539
  # to format a JSON parameter for the various command line tool
2274
- # environments, see [Using JSON for Parameters][1] in the *AWS CLI
2275
- # User Guide*. For example:
2540
+ # environments, see [Using JSON for Parameters][1] in the *CLI User
2541
+ # Guide*. For example:
2276
2542
  #
2277
2543
  # `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
2278
2544
  #
@@ -2435,9 +2701,9 @@ module Aws::SecretsManager
2435
2701
  # }
2436
2702
  #
2437
2703
  # @!attribute [rw] secret_id
2438
- # The identifier for the secret that you want to validate a resource
2439
- # policy. You can specify either the Amazon Resource Name (ARN) or the
2440
- # friendly name of the secret.
2704
+ # (Optional) The identifier of the secret with the resource-based
2705
+ # policy you want to validate. You can specify either the Amazon
2706
+ # Resource Name (ARN) or the friendly name of the secret.
2441
2707
  #
2442
2708
  # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2443
2709
  # complete ARN. You can specify a partial ARN too—for example, if you
@@ -2463,7 +2729,16 @@ module Aws::SecretsManager
2463
2729
  # @return [String]
2464
2730
  #
2465
2731
  # @!attribute [rw] resource_policy
2466
- # Identifies the Resource Policy attached to the secret.
2732
+ # A JSON-formatted string constructed according to the grammar and
2733
+ # syntax for an Amazon Web Services resource-based policy. The policy
2734
+ # in the string identifies who can access or manage this secret and
2735
+ # its versions. For information on how to format a JSON parameter for
2736
+ # the various command line tool environments, see [Using JSON for
2737
+ # Parameters][1] in the *CLI User Guide*.publi
2738
+ #
2739
+ #
2740
+ #
2741
+ # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
2467
2742
  # @return [String]
2468
2743
  #
2469
2744
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ValidateResourcePolicyRequest AWS API Documentation