com.amazonaws.services.secretsmanager.model.PutResourcePolicyRequest Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.secretsmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutResourcePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*/
private String secretId;
/**
*
* A JSON-formatted string 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.
*
*/
private String resourcePolicy;
/**
*
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*
*/
private Boolean blockPublicPolicy;
/**
*
* 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.
*
*
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @param 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.
*
* 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
*/
public void setSecretId(String secretId) {
this.secretId = 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.
*
*
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @return 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.
*
* 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
*/
public String getSecretId() {
return this.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.
*
*
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @param 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.
*
* 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withSecretId(String secretId) {
setSecretId(secretId);
return this;
}
/**
*
* A JSON-formatted string 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.
*
*
* @param resourcePolicy
* A JSON-formatted string 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.
*/
public void setResourcePolicy(String resourcePolicy) {
this.resourcePolicy = resourcePolicy;
}
/**
*
* A JSON-formatted string 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.
*
*
* @return A JSON-formatted string 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.
*/
public String getResourcePolicy() {
return this.resourcePolicy;
}
/**
*
* A JSON-formatted string 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.
*
*
* @param resourcePolicy
* A JSON-formatted string 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withResourcePolicy(String resourcePolicy) {
setResourcePolicy(resourcePolicy);
return this;
}
/**
*
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*
*
* @param blockPublicPolicy
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*/
public void setBlockPublicPolicy(Boolean blockPublicPolicy) {
this.blockPublicPolicy = blockPublicPolicy;
}
/**
*
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*
*
* @return (Optional) If you set the parameter, BlockPublicPolicy to true, then you block
* resource-based policies that allow broad access to the secret.
*/
public Boolean getBlockPublicPolicy() {
return this.blockPublicPolicy;
}
/**
*
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*
*
* @param blockPublicPolicy
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withBlockPublicPolicy(Boolean blockPublicPolicy) {
setBlockPublicPolicy(blockPublicPolicy);
return this;
}
/**
*
* (Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based
* policies that allow broad access to the secret.
*
*
* @return (Optional) If you set the parameter, BlockPublicPolicy to true, then you block
* resource-based policies that allow broad access to the secret.
*/
public Boolean isBlockPublicPolicy() {
return this.blockPublicPolicy;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSecretId() != null)
sb.append("SecretId: ").append(getSecretId()).append(",");
if (getResourcePolicy() != null)
sb.append("ResourcePolicy: ").append(getResourcePolicy()).append(",");
if (getBlockPublicPolicy() != null)
sb.append("BlockPublicPolicy: ").append(getBlockPublicPolicy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutResourcePolicyRequest == false)
return false;
PutResourcePolicyRequest other = (PutResourcePolicyRequest) obj;
if (other.getSecretId() == null ^ this.getSecretId() == null)
return false;
if (other.getSecretId() != null && other.getSecretId().equals(this.getSecretId()) == false)
return false;
if (other.getResourcePolicy() == null ^ this.getResourcePolicy() == null)
return false;
if (other.getResourcePolicy() != null && other.getResourcePolicy().equals(this.getResourcePolicy()) == false)
return false;
if (other.getBlockPublicPolicy() == null ^ this.getBlockPublicPolicy() == null)
return false;
if (other.getBlockPublicPolicy() != null && other.getBlockPublicPolicy().equals(this.getBlockPublicPolicy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecretId() == null) ? 0 : getSecretId().hashCode());
hashCode = prime * hashCode + ((getResourcePolicy() == null) ? 0 : getResourcePolicy().hashCode());
hashCode = prime * hashCode + ((getBlockPublicPolicy() == null) ? 0 : getBlockPublicPolicy().hashCode());
return hashCode;
}
@Override
public PutResourcePolicyRequest clone() {
return (PutResourcePolicyRequest) super.clone();
}
}