Package software.amazon.awssdk.services.secretsmanager.model

Interface PutResourcePolicyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, SdkBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder
Enclosing class:
PutResourcePolicyRequest
public static interface PutResourcePolicyRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • secretId

      PutResourcePolicyRequest.Builder secretId(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourcePolicy

      PutResourcePolicyRequest.Builder resourcePolicy(String resourcePolicy)

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

      Parameters:
      resourcePolicy - A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockPublicPolicy

      PutResourcePolicyRequest.Builder blockPublicPolicy(Boolean 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. By default, public policies aren't blocked.

      Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

      • Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

      • Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

      To review permissions to your secrets, see Determine who has permissions to your secrets.

      Parameters:
      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. By default, public policies aren't blocked.

      Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

      • Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

      • Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

      To review permissions to your secrets, see Determine who has permissions to your secrets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutResourcePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.