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>

Add Regions to replicate the secret.

Returns:



1581
1582
1583
1584
1585
1586
1587
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1581

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

#force_overwrite_replica_secretBoolean

(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region.

Returns:

  • (Boolean)


1581
1582
1583
1584
1585
1586
1587
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1581

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

#secret_idString

Use the Secret Id to replicate a secret to regions.

Returns:

  • (String)


1581
1582
1583
1584
1585
1586
1587
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1581

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