Class: Aws::SecretsManager::Types::AssociateCrossAccountReplicaRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cross_account_replica_arn ⇒ String

The ARN of the replica secret in the other Amazon Web Services account. The replica secret must be in the same Region and partition as the primary secret. Additionally, the replica account owner must have created the replica secret as a cross-account replica of the primary secret. For more information see CreateSecret.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 86

class AssociateCrossAccountReplicaRequest < Struct.new(
  :secret_id,
  :cross_account_replica_arn,
  :replica_restriction,
  :replication_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replica_restriction ⇒ String

Whether the replica account must belong to the same Amazon Web Services organization as the primary account:

  • SameOrg, which requires the replica account to be in the same organization as the primary account. This is the default.

  • NoRestriction, which allows the replica account to be in any organization.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 86

class AssociateCrossAccountReplicaRequest < Struct.new(
  :secret_id,
  :cross_account_replica_arn,
  :replica_restriction,
  :replication_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_role_arn ⇒ String

The ARN of an IAM role in the primary account that Secrets Manager assumes to perform replication. If you don't include this field, Secrets Manager replicates using the credentials of caller who updates the primary secret. For more information, see Cross-account replication permissions.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 86

class AssociateCrossAccountReplicaRequest < Struct.new(
  :secret_id,
  :cross_account_replica_arn,
  :replica_restriction,
  :replication_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#secret_id ⇒ String

The ARN or name of the primary secret in your account to replicate.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
 
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 86

class AssociateCrossAccountReplicaRequest < Struct.new(
  :secret_id,
  :cross_account_replica_arn,
  :replica_restriction,
  :replication_role_arn)
  SENSITIVE = []
  include Aws::Structure
end