Package 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("software.amazon.awssdk:codegen")
public final class PutResourcePolicyRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutResourcePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
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.
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 for an Amazon Web Services resource-based policy.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretId()	The ARN or name of the secret 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()

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:

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.

resourcePolicy

public final String resourcePolicy()

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

Returns:

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

blockPublicPolicy

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

Returns:

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.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo