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()
boolean	equals(Object obj)
Boolean	getBlockPublicPolicy() (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.
String	getResourcePolicy() A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
String	getSecretId() Specifies the secret that you want to attach the resource-based policy.
int	hashCode()
Boolean	isBlockPublicPolicy() (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.
void	setBlockPublicPolicy(Boolean blockPublicPolicy) (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.
void	setResourcePolicy(String resourcePolicy) A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
void	setSecretId(String secretId) Specifies the secret that you want to attach the resource-based policy.
String	toString() Returns a string representation of this object.
PutResourcePolicyRequest	withBlockPublicPolicy(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	withResourcePolicy(String resourcePolicy) A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
PutResourcePolicyRequest	withSecretId(String secretId) Specifies the secret that you want to attach the resource-based policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

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

Constructor Detail

PutResourcePolicyRequest

public PutResourcePolicyRequest()

Method Detail

setSecretId

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

getSecretId

public String getSecretId()

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.

withSecretId

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

setResourcePolicy

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

getResourcePolicy

public String getResourcePolicy()

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.

withResourcePolicy

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

setBlockPublicPolicy

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

getBlockPublicPolicy

public Boolean getBlockPublicPolicy()

(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.

withBlockPublicPolicy

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

isBlockPublicPolicy

public Boolean isBlockPublicPolicy()

(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.

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()

Overrides:

clone in class AmazonWebServiceRequest