Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecretsManager.ReplicateSecretToRegions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions.

Synopsis

Creating a Request

data ReplicateSecretToRegions Source #

See: newReplicateSecretToRegions smart constructor.

Constructors

ReplicateSecretToRegions'
Fields forceOverwriteReplicaSecret :: Maybe Bool (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. secretId :: Text Use the `Secret Id` to replicate a secret to regions. addReplicaRegions :: NonEmpty ReplicaRegionType Add Regions to replicate the secret.

Instances

Instances details

Eq ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods (==) :: ReplicateSecretToRegions -> ReplicateSecretToRegions -> Bool # (/=) :: ReplicateSecretToRegions -> ReplicateSecretToRegions -> Bool #
Read ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods readsPrec :: Int -> ReadS ReplicateSecretToRegions # readList :: ReadS [ReplicateSecretToRegions] # readPrec :: ReadPrec ReplicateSecretToRegions # readListPrec :: ReadPrec [ReplicateSecretToRegions] #
Show ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods showsPrec :: Int -> ReplicateSecretToRegions -> ShowS # show :: ReplicateSecretToRegions -> String # showList :: [ReplicateSecretToRegions] -> ShowS #
Generic ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Associated Types type Rep ReplicateSecretToRegions :: Type -> Type # Methods from :: ReplicateSecretToRegions -> Rep ReplicateSecretToRegions x # to :: Rep ReplicateSecretToRegions x -> ReplicateSecretToRegions #
NFData ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods rnf :: ReplicateSecretToRegions -> () #
Hashable ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods hashWithSalt :: Int -> ReplicateSecretToRegions -> Int # hash :: ReplicateSecretToRegions -> Int #
ToJSON ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods toJSON :: ReplicateSecretToRegions -> Value # toEncoding :: ReplicateSecretToRegions -> Encoding # toJSONList :: [ReplicateSecretToRegions] -> Value # toEncodingList :: [ReplicateSecretToRegions] -> Encoding #
AWSRequest ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Associated Types type AWSResponse ReplicateSecretToRegions # Methods request :: ReplicateSecretToRegions -> Request ReplicateSecretToRegions # response :: MonadResource m => Logger -> Service -> Proxy ReplicateSecretToRegions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReplicateSecretToRegions))) #
ToHeaders ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods toHeaders :: ReplicateSecretToRegions -> [Header] #
ToPath ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods toPath :: ReplicateSecretToRegions -> ByteString #
ToQuery ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods toQuery :: ReplicateSecretToRegions -> QueryString #
type Rep ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions type Rep ReplicateSecretToRegions = D1 ('MetaData "ReplicateSecretToRegions" "Amazonka.SecretsManager.ReplicateSecretToRegions" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" '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)))))
type AWSResponse ReplicateSecretToRegions Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions type AWSResponse ReplicateSecretToRegions = ReplicateSecretToRegionsResponse

newReplicateSecretToRegions Source #

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 - (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region.

$sel:secretId:ReplicateSecretToRegions', replicateSecretToRegions_secretId - Use the Secret Id to replicate a secret to regions.

$sel:addReplicaRegions:ReplicateSecretToRegions', replicateSecretToRegions_addReplicaRegions - Add Regions to replicate the secret.

Request Lenses

replicateSecretToRegions_forceOverwriteReplicaSecret :: Lens' ReplicateSecretToRegions (Maybe Bool) Source #

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

replicateSecretToRegions_secretId :: Lens' ReplicateSecretToRegions Text Source #

Use the Secret Id to replicate a secret to regions.

replicateSecretToRegions_addReplicaRegions :: Lens' ReplicateSecretToRegions (NonEmpty ReplicaRegionType) Source #

Add Regions to replicate the secret.

Destructuring the Response

data ReplicateSecretToRegionsResponse Source #

See: newReplicateSecretToRegionsResponse smart constructor.

Constructors

ReplicateSecretToRegionsResponse'
Fields arn :: Maybe Text Replicate a secret based on the `ReplicaRegionType`> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. replicationStatus :: Maybe [ReplicationStatusType] Describes the secret replication status as `PENDING`, `SUCCESS` or `FAIL`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods (==) :: ReplicateSecretToRegionsResponse -> ReplicateSecretToRegionsResponse -> Bool # (/=) :: ReplicateSecretToRegionsResponse -> ReplicateSecretToRegionsResponse -> Bool #
Read ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods readsPrec :: Int -> ReadS ReplicateSecretToRegionsResponse # readList :: ReadS [ReplicateSecretToRegionsResponse] # readPrec :: ReadPrec ReplicateSecretToRegionsResponse # readListPrec :: ReadPrec [ReplicateSecretToRegionsResponse] #
Show ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods showsPrec :: Int -> ReplicateSecretToRegionsResponse -> ShowS # show :: ReplicateSecretToRegionsResponse -> String # showList :: [ReplicateSecretToRegionsResponse] -> ShowS #
Generic ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Associated Types type Rep ReplicateSecretToRegionsResponse :: Type -> Type # Methods from :: ReplicateSecretToRegionsResponse -> Rep ReplicateSecretToRegionsResponse x # to :: Rep ReplicateSecretToRegionsResponse x -> ReplicateSecretToRegionsResponse #
NFData ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions Methods rnf :: ReplicateSecretToRegionsResponse -> () #
type Rep ReplicateSecretToRegionsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ReplicateSecretToRegions type Rep ReplicateSecretToRegionsResponse = D1 ('MetaData "ReplicateSecretToRegionsResponse" "Amazonka.SecretsManager.ReplicateSecretToRegions" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" '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 Source #

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:

$sel:arn:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_arn - Replicate a secret based on the ReplicaRegionType> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.

$sel:replicationStatus:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_replicationStatus - Describes the secret replication status as PENDING, SUCCESS or FAIL.

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

Response Lenses

replicateSecretToRegionsResponse_arn :: Lens' ReplicateSecretToRegionsResponse (Maybe Text) Source #

Replicate a secret based on the ReplicaRegionType> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.

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

Describes the secret replication status as PENDING, SUCCESS or FAIL.

replicateSecretToRegionsResponse_httpStatus :: Lens' ReplicateSecretToRegionsResponse Int Source #

The response's http status code.