com.amazonaws.services.secretsmanager.model

Class PutResourcePolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.secretsmanager.model.PutResourcePolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutResourcePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutResourcePolicyRequest()

Method Summary

Modifier and Type	Method and Description
PutResourcePolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getBlockPublicPolicy() Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
String	getResourcePolicy() A JSON-formatted string for an Amazon Web Services resource-based policy.
String	getSecretId() The ARN or name of the secret to attach the resource-based policy.
int	hashCode()
Boolean	isBlockPublicPolicy() Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
void	setBlockPublicPolicy(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.
void	setResourcePolicy(String resourcePolicy) A JSON-formatted string for an Amazon Web Services resource-based policy.
void	setSecretId(String secretId) The ARN or name of the secret to attach the resource-based policy.
String	toString() Returns a string representation of this object.
PutResourcePolicyRequest	withBlockPublicPolicy(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.
PutResourcePolicyRequest	withResourcePolicy(String resourcePolicy) A JSON-formatted string for an Amazon Web Services resource-based policy.
PutResourcePolicyRequest	withSecretId(String secretId) The ARN or name of the secret to attach the resource-based policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutResourcePolicyRequest

public PutResourcePolicyRequest()

Method Detail

setSecretId

public void setSecretId(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.

getSecretId

public String getSecretId()

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.

withSecretId

public PutResourcePolicyRequest withSecretId(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.

setResourcePolicy

public void setResourcePolicy(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.

getResourcePolicy

public String getResourcePolicy()

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.

withResourcePolicy

public PutResourcePolicyRequest withResourcePolicy(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.

setBlockPublicPolicy

public void setBlockPublicPolicy(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.

getBlockPublicPolicy

public Boolean getBlockPublicPolicy()

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.

withBlockPublicPolicy

public PutResourcePolicyRequest withBlockPublicPolicy(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.

isBlockPublicPolicy

public Boolean isBlockPublicPolicy()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutResourcePolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()