/* * 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 CreatePermissionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services * Region. *
*/ private String name; /** ** Specifies the name of the resource type that this customer managed permission applies to. *
*
* The format is <service-code>:<resource-type>
and is not case sensitive.
* For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
. To see the list of
* valid values for this parameter, query the ListResourceTypes operation.
*
* 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 a list of one or more tag key and value pairs to attach to the permission. *
*/ private java.util.List* Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services * Region. *
* * @param name * Specifies the name of the customer managed permission. The name must be unique within the Amazon Web * Services Region. */ public void setName(String name) { this.name = name; } /** ** Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services * Region. *
* * @return Specifies the name of the customer managed permission. The name must be unique within the Amazon Web * Services Region. */ public String getName() { return this.name; } /** ** Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services * Region. *
* * @param name * Specifies the name of the customer managed permission. The name must be unique within the Amazon Web * Services Region. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePermissionRequest withName(String name) { setName(name); return this; } /** ** Specifies the name of the resource type that this customer managed permission applies to. *
*
* The format is <service-code>:<resource-type>
and is not case sensitive.
* For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
. To see the list of
* valid values for this parameter, query the ListResourceTypes operation.
*
* The format is <service-code>:<resource-type>
and is not case
* sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
.
* To see the list of valid values for this parameter, query the ListResourceTypes operation.
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* Specifies the name of the resource type that this customer managed permission applies to. *
*
* The format is <service-code>:<resource-type>
and is not case sensitive.
* For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
. To see the list of
* valid values for this parameter, query the ListResourceTypes operation.
*
* The format is <service-code>:<resource-type>
and is not case
* sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
.
* To see the list of valid values for this parameter, query the ListResourceTypes operation.
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* Specifies the name of the resource type that this customer managed permission applies to. *
*
* The format is <service-code>:<resource-type>
and is not case sensitive.
* For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
. To see the list of
* valid values for this parameter, query the ListResourceTypes operation.
*
* The format is <service-code>:<resource-type>
and is not case
* sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet
.
* To see the list of valid values for this parameter, query the ListResourceTypes operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionRequest withResourceType(String resourceType) {
setResourceType(resourceType);
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 CreatePermissionRequest 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 CreatePermissionRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* Specifies a list of one or more tag key and value pairs to attach to the permission. *
* * @return Specifies a list of one or more tag key and value pairs to attach to the permission. */ public java.util.List* Specifies a list of one or more tag key and value pairs to attach to the permission. *
* * @param tags * Specifies a list of one or more tag key and value pairs to attach to the permission. */ public void setTags(java.util.Collection* Specifies a list of one or more tag key and value pairs to attach to the permission. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * Specifies a list of one or more tag key and value pairs to attach to the permission. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePermissionRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* Specifies a list of one or more tag key and value pairs to attach to the permission. *
* * @param tags * Specifies a list of one or more tag key and value pairs to attach to the permission. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePermissionRequest withTags(java.util.Collection