software.amazon.awssdk.services.secretsmanager.model

Class PutResourcePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest

software.amazon.awssdk.services.secretsmanager.model.PutResourcePolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutResourcePolicyRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutResourcePolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	blockPublicPolicy() (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.
static PutResourcePolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	resourcePolicy() A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
List<SdkField<?>>	sdkFields()
String	secretId() Specifies the secret that you want to attach the resource-based policy.
static Class<? extends PutResourcePolicyRequest.Builder>	serializableBuilderClass()
PutResourcePolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

secretId

public final 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.

Returns:

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.

resourcePolicy

public final 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.

Returns:

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.

blockPublicPolicy

public final Boolean blockPublicPolicy()

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

Returns:

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

toBuilder

public PutResourcePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

Specified by:

toBuilder in class SecretsManagerRequest

builder

public static PutResourcePolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutResourcePolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo