putResourcePolicy method

Future<PutResourcePolicyResponse> putResourcePolicy({ required String resourcePolicy, required String secretId, bool? blockPublicPolicy, })

Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

Minimum permissions

To run this command, you must have the following permissions:

• secretsmanager:PutResourcePolicy

Related operations

• To retrieve the resource policy attached to a secret, use GetResourcePolicy.
• To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.
• To list all of the currently available secrets, use ListSecrets.

May throw MalformedPolicyDocumentException. May throw ResourceNotFoundException. May throw InvalidParameterException. May throw InternalServiceError. May throw InvalidRequestException. May throw PublicPolicyException.

Parameter resourcePolicy : A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

Parameter secretId : Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Parameter blockPublicPolicy : Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

Implementation

Future<PutResourcePolicyResponse> putResourcePolicy({
  required String resourcePolicy,
  required String secretId,
  bool? blockPublicPolicy,
}) async {
  ArgumentError.checkNotNull(resourcePolicy, 'resourcePolicy');
  _s.validateStringLength(
    'resourcePolicy',
    resourcePolicy,
    1,
    20480,
    isRequired: true,
  );
  ArgumentError.checkNotNull(secretId, 'secretId');
  _s.validateStringLength(
    'secretId',
    secretId,
    1,
    2048,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'secretsmanager.PutResourcePolicy'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ResourcePolicy': resourcePolicy,
      'SecretId': secretId,
      if (blockPublicPolicy != null) 'BlockPublicPolicy': blockPublicPolicy,
    },
  );

  return PutResourcePolicyResponse.fromJson(jsonResponse.body);
}