Amazonka.SecretsManager.RemoveRegionsFromReplication

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

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:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data RemoveRegionsFromReplication

See: newRemoveRegionsFromReplication smart constructor.

Constructors

RemoveRegionsFromReplication'

Fields

• secretId :: Text

  The ARN or name of the secret.

• removeReplicaRegions :: NonEmpty Text

  The Regions of the replicas to remove.

Instances

ToJSON RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

toJSON :: RemoveRegionsFromReplication -> Value

toEncoding :: RemoveRegionsFromReplication -> Encoding

toJSONList :: [RemoveRegionsFromReplication] -> Value

toEncodingList :: [RemoveRegionsFromReplication] -> Encoding

ToHeaders RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

toHeaders :: RemoveRegionsFromReplication -> [Header]

ToPath RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

toPath :: RemoveRegionsFromReplication -> ByteString

ToQuery RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

toQuery :: RemoveRegionsFromReplication -> QueryString

AWSRequest RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Associated Types

type AWSResponse RemoveRegionsFromReplication

Methods

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

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

Generic RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Associated Types

type Rep RemoveRegionsFromReplication :: Type -> Type

Methods

from :: RemoveRegionsFromReplication -> Rep RemoveRegionsFromReplication x

to :: Rep RemoveRegionsFromReplication x -> RemoveRegionsFromReplication

Read RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

readsPrec :: Int -> ReadS RemoveRegionsFromReplication

readList :: ReadS [RemoveRegionsFromReplication]

readPrec :: ReadPrec RemoveRegionsFromReplication

readListPrec :: ReadPrec [RemoveRegionsFromReplication]

Show RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

showsPrec :: Int -> RemoveRegionsFromReplication -> ShowS

show :: RemoveRegionsFromReplication -> String

showList :: [RemoveRegionsFromReplication] -> ShowS

NFData RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

rnf :: RemoveRegionsFromReplication -> ()

Eq RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

(==) :: RemoveRegionsFromReplication -> RemoveRegionsFromReplication -> Bool

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

Hashable RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

hashWithSalt :: Int -> RemoveRegionsFromReplication -> Int

hash :: RemoveRegionsFromReplication -> Int

type AWSResponse RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type AWSResponse RemoveRegionsFromReplication = RemoveRegionsFromReplicationResponse

type Rep RemoveRegionsFromReplication

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

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

newRemoveRegionsFromReplication

Arguments

:: Text

$sel:secretId:RemoveRegionsFromReplication'

-> NonEmpty Text

$sel:removeReplicaRegions:RemoveRegionsFromReplication'

-> RemoveRegionsFromReplication

Create a value of RemoveRegionsFromReplication 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:secretId:RemoveRegionsFromReplication', removeRegionsFromReplication_secretId - The ARN or name of the secret.

$sel:removeReplicaRegions:RemoveRegionsFromReplication', removeRegionsFromReplication_removeReplicaRegions - The Regions of the replicas to remove.

Request Lenses

removeRegionsFromReplication_secretId :: Lens' RemoveRegionsFromReplication Text

The ARN or name of the secret.

removeRegionsFromReplication_removeReplicaRegions :: Lens' RemoveRegionsFromReplication (NonEmpty Text)

The Regions of the replicas to remove.

Destructuring the Response

data RemoveRegionsFromReplicationResponse

See: newRemoveRegionsFromReplicationResponse smart constructor.

Constructors

RemoveRegionsFromReplicationResponse'

Fields

• arn :: Maybe Text

  The ARN of the primary secret.

• replicationStatus :: Maybe [ReplicationStatusType]

  The status of replicas for this secret after you remove Regions.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Associated Types

type Rep RemoveRegionsFromReplicationResponse :: Type -> Type

Methods

from :: RemoveRegionsFromReplicationResponse -> Rep RemoveRegionsFromReplicationResponse x

to :: Rep RemoveRegionsFromReplicationResponse x -> RemoveRegionsFromReplicationResponse

Read RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

readsPrec :: Int -> ReadS RemoveRegionsFromReplicationResponse

readList :: ReadS [RemoveRegionsFromReplicationResponse]

readPrec :: ReadPrec RemoveRegionsFromReplicationResponse

readListPrec :: ReadPrec [RemoveRegionsFromReplicationResponse]

Show RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

showsPrec :: Int -> RemoveRegionsFromReplicationResponse -> ShowS

show :: RemoveRegionsFromReplicationResponse -> String

showList :: [RemoveRegionsFromReplicationResponse] -> ShowS

NFData RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

rnf :: RemoveRegionsFromReplicationResponse -> ()

Eq RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

Methods

(==) :: RemoveRegionsFromReplicationResponse -> RemoveRegionsFromReplicationResponse -> Bool

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

type Rep RemoveRegionsFromReplicationResponse

Defined in Amazonka.SecretsManager.RemoveRegionsFromReplication

type Rep RemoveRegionsFromReplicationResponse = D1 ('MetaData "RemoveRegionsFromReplicationResponse" "Amazonka.SecretsManager.RemoveRegionsFromReplication" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "RemoveRegionsFromReplicationResponse'" '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))))

newRemoveRegionsFromReplicationResponse

Arguments

:: Int

$sel:httpStatus:RemoveRegionsFromReplicationResponse'

-> RemoveRegionsFromReplicationResponse

Create a value of RemoveRegionsFromReplicationResponse 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:

RemoveRegionsFromReplicationResponse, removeRegionsFromReplicationResponse_arn - The ARN of the primary secret.

$sel:replicationStatus:RemoveRegionsFromReplicationResponse', removeRegionsFromReplicationResponse_replicationStatus - The status of replicas for this secret after you remove Regions.

$sel:httpStatus:RemoveRegionsFromReplicationResponse', removeRegionsFromReplicationResponse_httpStatus - The response's http status code.

Response Lenses

removeRegionsFromReplicationResponse_arn :: Lens' RemoveRegionsFromReplicationResponse (Maybe Text)

The ARN of the primary secret.

removeRegionsFromReplicationResponse_replicationStatus :: Lens' RemoveRegionsFromReplicationResponse (Maybe [ReplicationStatusType])

The status of replicas for this secret after you remove Regions.

removeRegionsFromReplicationResponse_httpStatus :: Lens' RemoveRegionsFromReplicationResponse Int

The response's http status code.