Class: Aws::SecretsManager::Types::ReplicateSecretToRegionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass ReplicateSecretToRegionsRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  add_replica_regions: [ # required
    {
      region: "RegionType",
      kms_key_id: "KmsKeyIdType",
    },
  ],
  force_overwrite_replica_secret: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_replica_regionsArray<Types::ReplicaRegionType>

A list of Regions in which to replicate the secret.

Returns:



1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1538

class ReplicateSecretToRegionsRequest < Struct.new(
  :secret_id,
  :add_replica_regions,
  :force_overwrite_replica_secret)
  SENSITIVE = []
  include Aws::Structure
end

#force_overwrite_replica_secretBoolean

Specifies whether to overwrite a secret with the same name in the destination Region.

Returns:

  • (Boolean)


1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1538

class ReplicateSecretToRegionsRequest < Struct.new(
  :secret_id,
  :add_replica_regions,
  :force_overwrite_replica_secret)
  SENSITIVE = []
  include Aws::Structure
end

#secret_idString

The ARN or name of the secret to replicate.

Returns:

  • (String)


1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1538

class ReplicateSecretToRegionsRequest < Struct.new(
  :secret_id,
  :add_replica_regions,
  :force_overwrite_replica_secret)
  SENSITIVE = []
  include Aws::Structure
end