Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SecretsManager.PutResourcePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

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

Creating a Request

data PutResourcePolicy Source #

See: newPutResourcePolicy smart constructor.

Constructors

PutResourcePolicy'

Fields

blockPublicPolicy :: Maybe Bool
Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
secretId :: Text
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
resourcePolicy :: Text
A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

Instances

Instances details

ToJSON PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods toJSON :: PutResourcePolicy -> Value # toEncoding :: PutResourcePolicy -> Encoding # toJSONList :: [PutResourcePolicy] -> Value # toEncodingList :: [PutResourcePolicy] -> Encoding #
ToHeaders PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods toHeaders :: PutResourcePolicy -> [Header] #
ToPath PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods toPath :: PutResourcePolicy -> ByteString #
ToQuery PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods toQuery :: PutResourcePolicy -> QueryString #
AWSRequest PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Associated Types type AWSResponse PutResourcePolicy # Methods request :: (Service -> Service) -> PutResourcePolicy -> Request PutResourcePolicy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutResourcePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutResourcePolicy))) #
Generic PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Associated Types type Rep PutResourcePolicy :: Type -> Type # Methods from :: PutResourcePolicy -> Rep PutResourcePolicy x # to :: Rep PutResourcePolicy x -> PutResourcePolicy #
Read PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods readsPrec :: Int -> ReadS PutResourcePolicy # readList :: ReadS [PutResourcePolicy] # readPrec :: ReadPrec PutResourcePolicy # readListPrec :: ReadPrec [PutResourcePolicy] #
Show PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods showsPrec :: Int -> PutResourcePolicy -> ShowS # show :: PutResourcePolicy -> String # showList :: [PutResourcePolicy] -> ShowS #
NFData PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods rnf :: PutResourcePolicy -> () #
Eq PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods (==) :: PutResourcePolicy -> PutResourcePolicy -> Bool # (/=) :: PutResourcePolicy -> PutResourcePolicy -> Bool #
Hashable PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods hashWithSalt :: Int -> PutResourcePolicy -> Int # hash :: PutResourcePolicy -> Int #
type AWSResponse PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy type AWSResponse PutResourcePolicy = PutResourcePolicyResponse
type Rep PutResourcePolicy Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy type Rep PutResourcePolicy = D1 ('MetaData "PutResourcePolicy" "Amazonka.SecretsManager.PutResourcePolicy" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "PutResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockPublicPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutResourcePolicy Source #

Arguments

:: Text	`$sel:secretId:PutResourcePolicy'`
-> Text	`$sel:resourcePolicy:PutResourcePolicy'`
-> PutResourcePolicy

Create a value of PutResourcePolicy 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:blockPublicPolicy:PutResourcePolicy', putResourcePolicy_blockPublicPolicy - Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.

$sel:secretId:PutResourcePolicy', putResourcePolicy_secretId - The ARN or name of the secret to attach the resource-based policy.

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

$sel:resourcePolicy:PutResourcePolicy', putResourcePolicy_resourcePolicy - A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

Request Lenses

putResourcePolicy_blockPublicPolicy :: Lens' PutResourcePolicy (Maybe Bool) Source #

Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.

putResourcePolicy_secretId :: Lens' PutResourcePolicy Text Source #

The ARN or name of the secret to attach the resource-based policy.

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

putResourcePolicy_resourcePolicy :: Lens' PutResourcePolicy Text Source #

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

Destructuring the Response

data PutResourcePolicyResponse Source #

See: newPutResourcePolicyResponse smart constructor.

Constructors

PutResourcePolicyResponse'
Fields arn :: Maybe Text The ARN of the secret. name :: Maybe Text The name of the secret. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Associated Types type Rep PutResourcePolicyResponse :: Type -> Type # Methods from :: PutResourcePolicyResponse -> Rep PutResourcePolicyResponse x # to :: Rep PutResourcePolicyResponse x -> PutResourcePolicyResponse #
Read PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods readsPrec :: Int -> ReadS PutResourcePolicyResponse # readList :: ReadS [PutResourcePolicyResponse] # readPrec :: ReadPrec PutResourcePolicyResponse # readListPrec :: ReadPrec [PutResourcePolicyResponse] #
Show PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods showsPrec :: Int -> PutResourcePolicyResponse -> ShowS # show :: PutResourcePolicyResponse -> String # showList :: [PutResourcePolicyResponse] -> ShowS #
NFData PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods rnf :: PutResourcePolicyResponse -> () #
Eq PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy Methods (==) :: PutResourcePolicyResponse -> PutResourcePolicyResponse -> Bool # (/=) :: PutResourcePolicyResponse -> PutResourcePolicyResponse -> Bool #
type Rep PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutResourcePolicy type Rep PutResourcePolicyResponse = D1 ('MetaData "PutResourcePolicyResponse" "Amazonka.SecretsManager.PutResourcePolicy" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "PutResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutResourcePolicyResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutResourcePolicyResponse'`
-> PutResourcePolicyResponse

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

PutResourcePolicyResponse, putResourcePolicyResponse_arn - The ARN of the secret.

PutResourcePolicyResponse, putResourcePolicyResponse_name - The name of the secret.

$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.

Response Lenses

putResourcePolicyResponse_arn :: Lens' PutResourcePolicyResponse (Maybe Text) Source #

The ARN of the secret.

putResourcePolicyResponse_name :: Lens' PutResourcePolicyResponse (Maybe Text) Source #

The name of the secret.

putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #

The response's http status code.