Amazonka.SecretsManager.ReplicateSecretToRegions

Replicates the secret to a new Regions. See Multi-Region secrets.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data ReplicateSecretToRegions

See: newReplicateSecretToRegions smart constructor.

Constructors

ReplicateSecretToRegions'

Fields

• forceOverwriteReplicaSecret :: Maybe Bool

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

• secretId :: Text

  The ARN or name of the secret to replicate.

• addReplicaRegions :: NonEmpty ReplicaRegionType

  A list of Regions in which to replicate the secret.

Instances

ToJSON ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

toJSON :: ReplicateSecretToRegions -> Value

toEncoding :: ReplicateSecretToRegions -> Encoding

toJSONList :: [ReplicateSecretToRegions] -> Value

toEncodingList :: [ReplicateSecretToRegions] -> Encoding

ToHeaders ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

toHeaders :: ReplicateSecretToRegions -> [Header]

ToPath ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

toPath :: ReplicateSecretToRegions -> ByteString

ToQuery ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

toQuery :: ReplicateSecretToRegions -> QueryString

AWSRequest ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Associated Types

type AWSResponse ReplicateSecretToRegions

Methods

request :: (Service -> Service) -> ReplicateSecretToRegions -> Request ReplicateSecretToRegions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReplicateSecretToRegions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReplicateSecretToRegions)))

Generic ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Associated Types

type Rep ReplicateSecretToRegions :: Type -> Type

Methods

from :: ReplicateSecretToRegions -> Rep ReplicateSecretToRegions x

to :: Rep ReplicateSecretToRegions x -> ReplicateSecretToRegions

Read ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

readsPrec :: Int -> ReadS ReplicateSecretToRegions

readList :: ReadS [ReplicateSecretToRegions]

readPrec :: ReadPrec ReplicateSecretToRegions

readListPrec :: ReadPrec [ReplicateSecretToRegions]

Show ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

showsPrec :: Int -> ReplicateSecretToRegions -> ShowS

show :: ReplicateSecretToRegions -> String

showList :: [ReplicateSecretToRegions] -> ShowS

NFData ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

rnf :: ReplicateSecretToRegions -> ()

Eq ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

(==) :: ReplicateSecretToRegions -> ReplicateSecretToRegions -> Bool

(/=) :: ReplicateSecretToRegions -> ReplicateSecretToRegions -> Bool

Hashable ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

hashWithSalt :: Int -> ReplicateSecretToRegions -> Int

hash :: ReplicateSecretToRegions -> Int

type AWSResponse ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type AWSResponse ReplicateSecretToRegions = ReplicateSecretToRegionsResponse

type Rep ReplicateSecretToRegions

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegions = D1 ('MetaData "ReplicateSecretToRegions" "Amazonka.SecretsManager.ReplicateSecretToRegions" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "ReplicateSecretToRegions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceOverwriteReplicaSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "addReplicaRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ReplicaRegionType)))))

newReplicateSecretToRegions

Arguments

:: Text

$sel:secretId:ReplicateSecretToRegions'

-> NonEmpty ReplicaRegionType

$sel:addReplicaRegions:ReplicateSecretToRegions'

-> ReplicateSecretToRegions

Create a value of ReplicateSecretToRegions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forceOverwriteReplicaSecret:ReplicateSecretToRegions', replicateSecretToRegions_forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the destination Region.

$sel:secretId:ReplicateSecretToRegions', replicateSecretToRegions_secretId - The ARN or name of the secret to replicate.

$sel:addReplicaRegions:ReplicateSecretToRegions', replicateSecretToRegions_addReplicaRegions - A list of Regions in which to replicate the secret.

Request Lenses

replicateSecretToRegions_forceOverwriteReplicaSecret :: Lens' ReplicateSecretToRegions (Maybe Bool)

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

replicateSecretToRegions_secretId :: Lens' ReplicateSecretToRegions Text

The ARN or name of the secret to replicate.

replicateSecretToRegions_addReplicaRegions :: Lens' ReplicateSecretToRegions (NonEmpty ReplicaRegionType)

A list of Regions in which to replicate the secret.

Destructuring the Response

data ReplicateSecretToRegionsResponse

See: newReplicateSecretToRegionsResponse smart constructor.

Constructors

ReplicateSecretToRegionsResponse'

Fields

• arn :: Maybe Text

  The ARN of the primary secret.

• replicationStatus :: Maybe [ReplicationStatusType]

  The status of replication.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Associated Types

type Rep ReplicateSecretToRegionsResponse :: Type -> Type

Methods

from :: ReplicateSecretToRegionsResponse -> Rep ReplicateSecretToRegionsResponse x

to :: Rep ReplicateSecretToRegionsResponse x -> ReplicateSecretToRegionsResponse

Read ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

readsPrec :: Int -> ReadS ReplicateSecretToRegionsResponse

readList :: ReadS [ReplicateSecretToRegionsResponse]

readPrec :: ReadPrec ReplicateSecretToRegionsResponse

readListPrec :: ReadPrec [ReplicateSecretToRegionsResponse]

Show ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

showsPrec :: Int -> ReplicateSecretToRegionsResponse -> ShowS

show :: ReplicateSecretToRegionsResponse -> String

showList :: [ReplicateSecretToRegionsResponse] -> ShowS

NFData ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

rnf :: ReplicateSecretToRegionsResponse -> ()

Eq ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

Methods

(==) :: ReplicateSecretToRegionsResponse -> ReplicateSecretToRegionsResponse -> Bool

(/=) :: ReplicateSecretToRegionsResponse -> ReplicateSecretToRegionsResponse -> Bool

type Rep ReplicateSecretToRegionsResponse

Defined in Amazonka.SecretsManager.ReplicateSecretToRegions

type Rep ReplicateSecretToRegionsResponse = D1 ('MetaData "ReplicateSecretToRegionsResponse" "Amazonka.SecretsManager.ReplicateSecretToRegions" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "ReplicateSecretToRegionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationStatusType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newReplicateSecretToRegionsResponse

Arguments

:: Int

$sel:httpStatus:ReplicateSecretToRegionsResponse'

-> ReplicateSecretToRegionsResponse

Create a value of ReplicateSecretToRegionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ReplicateSecretToRegionsResponse, replicateSecretToRegionsResponse_arn - The ARN of the primary secret.

$sel:replicationStatus:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_replicationStatus - The status of replication.

$sel:httpStatus:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_httpStatus - The response's http status code.

Response Lenses

replicateSecretToRegionsResponse_arn :: Lens' ReplicateSecretToRegionsResponse (Maybe Text)

The ARN of the primary secret.

replicateSecretToRegionsResponse_replicationStatus :: Lens' ReplicateSecretToRegionsResponse (Maybe [ReplicationStatusType])

The status of replication.

replicateSecretToRegionsResponse_httpStatus :: Lens' ReplicateSecretToRegionsResponse Int

The response's http status code.