public static interface PutResourcePolicyRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
Modifier and Type | Method and Description |
---|---|
PutResourcePolicyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutResourcePolicyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutResourcePolicyRequest.Builder |
resourcePolicy(String resourcePolicy)
A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based
policy.
|
PutResourcePolicyRequest.Builder |
secretId(String secretId)
Specifies the secret that you want to attach the resource-based policy to.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutResourcePolicyRequest.Builder secretId(String 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 ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
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 ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
PutResourcePolicyRequest.Builder resourcePolicy(String 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.
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.PutResourcePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2020. All rights reserved.