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 Summary

Modifier and Type	Method and Description
PutResourcePolicyRequest.Builder	blockPublicPolicy(Boolean blockPublicPolicy) (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.
PutResourcePolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutResourcePolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutResourcePolicyRequest.Builder	resourcePolicy(String resourcePolicy) A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
PutResourcePolicyRequest.Builder	secretId(String secretId) Specifies the secret that you want to attach the resource-based policy.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

secretId

PutResourcePolicyRequest.Builder secretId(String secretId)

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

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Parameters:

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

For an ARN, we recommend that you specify a complete ARN rather than 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 constructed according to the grammar and syntax for an Amazon Web Services 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 CLI User Guide.

Parameters:

resourcePolicy - A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services 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 CLI User Guide.

Returns:

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

blockPublicPolicy

PutResourcePolicyRequest.Builder blockPublicPolicy(Boolean blockPublicPolicy)

(Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Parameters:

blockPublicPolicy - (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Returns:

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

overrideConfiguration

PutResourcePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder