/* * Copyright 2018-2023 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.ram.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 CreatePermissionVersionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. *
*/ private String permissionArn; /** ** A string in JSON format string that contains the following elements of a resource-based policy: *
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must contain * only actions that are supported by the specified resource type. For a list of all actions supported by each * resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an * action for that action to be allowed. For more information about the Condition element, see IAM policies: * Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are both
* filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
* permission. The Resource
comes from the ARN of the specific resource that you are sharing. The
* Principal
comes from the list of identities added to the resource share.
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This * lets you safely retry the request without accidentally performing the same operation a second time. Passing the * same value to a later call to an operation requires that you also pass the same value for all other parameters. * We recommend that you use a UUID type of * value.. *
** If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the retry fails
* with an IdempotentParameterMismatch
error.
*
* Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. *
* * @param permissionArn * Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. */ public void setPermissionArn(String permissionArn) { this.permissionArn = permissionArn; } /** ** Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. *
* * @return Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. */ public String getPermissionArn() { return this.permissionArn; } /** ** Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. *
* * @param permissionArn * Specifies the Amazon * Resource Name (ARN) of the customer managed permission you're creating a new version for. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePermissionVersionRequest withPermissionArn(String permissionArn) { setPermissionArn(permissionArn); return this; } /** ** A string in JSON format string that contains the following elements of a resource-based policy: *
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must contain * only actions that are supported by the specified resource type. For a list of all actions supported by each * resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an * action for that action to be allowed. For more information about the Condition element, see IAM policies: * Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are both
* filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
* permission. The Resource
comes from the ARN of the specific resource that you are sharing. The
* Principal
comes from the list of identities added to the resource share.
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must * contain only actions that are supported by the specified resource type. For a list of all actions * supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user * attempts an action for that action to be allowed. For more information about the Condition element, see IAM * policies: Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are
* both filled in by RAM when it instantiates the resource-based policy on each resource shared using this
* managed permission. The Resource
comes from the ARN of the specific resource that you are
* sharing. The Principal
comes from the list of identities added to the resource share.
*/
public void setPolicyTemplate(String policyTemplate) {
this.policyTemplate = policyTemplate;
}
/**
*
* A string in JSON format string that contains the following elements of a resource-based policy: *
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must contain * only actions that are supported by the specified resource type. For a list of all actions supported by each * resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an * action for that action to be allowed. For more information about the Condition element, see IAM policies: * Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are both
* filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
* permission. The Resource
comes from the ARN of the specific resource that you are sharing. The
* Principal
comes from the list of identities added to the resource share.
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must * contain only actions that are supported by the specified resource type. For a list of all actions * supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and * Access Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user * attempts an action for that action to be allowed. For more information about the Condition element, see * IAM * policies: Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those
* are both filled in by RAM when it instantiates the resource-based policy on each resource shared using
* this managed permission. The Resource
comes from the ARN of the specific resource that you
* are sharing. The Principal
comes from the list of identities added to the resource share.
*/
public String getPolicyTemplate() {
return this.policyTemplate;
}
/**
*
* A string in JSON format string that contains the following elements of a resource-based policy: *
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must contain * only actions that are supported by the specified resource type. For a list of all actions supported by each * resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an * action for that action to be allowed. For more information about the Condition element, see IAM policies: * Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are both
* filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
* permission. The Resource
comes from the ARN of the specific resource that you are sharing. The
* Principal
comes from the list of identities added to the resource share.
*
* Effect: must be set to ALLOW
.
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must * contain only actions that are supported by the specified resource type. For a list of all actions * supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access * Management User Guide. *
** Condition: (optional) specifies conditional parameters that must evaluate to true when a user * attempts an action for that action to be allowed. For more information about the Condition element, see IAM * policies: Condition element in the Identity and Access Management User Guide. *
*
* This template can't include either the Resource
or Principal
elements. Those are
* both filled in by RAM when it instantiates the resource-based policy on each resource shared using this
* managed permission. The Resource
comes from the ARN of the specific resource that you are
* sharing. The Principal
comes from the list of identities added to the resource share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionVersionRequest withPolicyTemplate(String policyTemplate) {
setPolicyTemplate(policyTemplate);
return this;
}
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This * lets you safely retry the request without accidentally performing the same operation a second time. Passing the * same value to a later call to an operation requires that you also pass the same value for all other parameters. * We recommend that you use a UUID type of * value.. *
** If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the retry fails
* with an IdempotentParameterMismatch
error.
*
* If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the
* retry fails with an IdempotentParameterMismatch
error.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This * lets you safely retry the request without accidentally performing the same operation a second time. Passing the * same value to a later call to an operation requires that you also pass the same value for all other parameters. * We recommend that you use a UUID type of * value.. *
** If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the retry fails
* with an IdempotentParameterMismatch
error.
*
* If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the
* retry fails with an IdempotentParameterMismatch
error.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This * lets you safely retry the request without accidentally performing the same operation a second time. Passing the * same value to a later call to an operation requires that you also pass the same value for all other parameters. * We recommend that you use a UUID type of * value.. *
** If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the retry fails
* with an IdempotentParameterMismatch
error.
*
* If you don't provide this value, then Amazon Web Services generates a random one for you. *
*
* If you retry the operation with the same ClientToken
, but with different parameters, the
* retry fails with an IdempotentParameterMismatch
error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionVersionRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
* 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 (getPermissionArn() != null)
sb.append("PermissionArn: ").append(getPermissionArn()).append(",");
if (getPolicyTemplate() != null)
sb.append("PolicyTemplate: ").append(getPolicyTemplate()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePermissionVersionRequest == false)
return false;
CreatePermissionVersionRequest other = (CreatePermissionVersionRequest) obj;
if (other.getPermissionArn() == null ^ this.getPermissionArn() == null)
return false;
if (other.getPermissionArn() != null && other.getPermissionArn().equals(this.getPermissionArn()) == false)
return false;
if (other.getPolicyTemplate() == null ^ this.getPolicyTemplate() == null)
return false;
if (other.getPolicyTemplate() != null && other.getPolicyTemplate().equals(this.getPolicyTemplate()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPermissionArn() == null) ? 0 : getPermissionArn().hashCode());
hashCode = prime * hashCode + ((getPolicyTemplate() == null) ? 0 : getPolicyTemplate().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreatePermissionVersionRequest clone() {
return (CreatePermissionVersionRequest) super.clone();
}
}