/* * 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 CreateResourceShareRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* Specifies the name of the resource share. *

*/ private String name; /** *

* Specifies a list of one or more ARNs of the resources to associate with the resource share. *

*/ private java.util.List resourceArns; /** *

* Specifies a list of one or more principals to associate with the resource share. *

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource Name * (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* */ private java.util.List principals; /** *

* Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources * associated with the resource share. *

*/ private java.util.List tags; /** *

* Specifies whether principals outside your organization in Organizations can be associated with a resource share. * A value of true lets you share with individual Amazon Web Services accounts that are not in * your organization. A value of false only has meaning if your account is a member of an Amazon Web * Services Organization. The default value is true. *

*/ private Boolean allowExternalPrincipals; /** *

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

*/ private String clientToken; /** *

* Specifies the Amazon * Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an * ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. * You can associate only one permission with each resource type included in the resource share. *

*/ private java.util.List permissionArns; /** *

* Specifies from which source accounts the service principal has access to the resources in this resource share. *

*/ private java.util.List sources; /** *

* Specifies the name of the resource share. *

* * @param name * Specifies the name of the resource share. */ public void setName(String name) { this.name = name; } /** *

* Specifies the name of the resource share. *

* * @return Specifies the name of the resource share. */ public String getName() { return this.name; } /** *

* Specifies the name of the resource share. *

* * @param name * Specifies the name of the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withName(String name) { setName(name); return this; } /** *

* Specifies a list of one or more ARNs of the resources to associate with the resource share. *

* * @return Specifies a list of one or more ARNs of the resources to associate with the resource share. */ public java.util.List getResourceArns() { return resourceArns; } /** *

* Specifies a list of one or more ARNs of the resources to associate with the resource share. *

* * @param resourceArns * Specifies a list of one or more ARNs of the resources to associate with the resource share. */ public void setResourceArns(java.util.Collection resourceArns) { if (resourceArns == null) { this.resourceArns = null; return; } this.resourceArns = new java.util.ArrayList(resourceArns); } /** *

* Specifies a list of one or more ARNs of the resources to associate with the resource share. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setResourceArns(java.util.Collection)} or {@link #withResourceArns(java.util.Collection)} if you want to * override the existing values. *

* * @param resourceArns * Specifies a list of one or more ARNs of the resources to associate with the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withResourceArns(String... resourceArns) { if (this.resourceArns == null) { setResourceArns(new java.util.ArrayList(resourceArns.length)); } for (String ele : resourceArns) { this.resourceArns.add(ele); } return this; } /** *

* Specifies a list of one or more ARNs of the resources to associate with the resource share. *

* * @param resourceArns * Specifies a list of one or more ARNs of the resources to associate with the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withResourceArns(java.util.Collection resourceArns) { setResourceArns(resourceArns); return this; } /** *

* Specifies a list of one or more principals to associate with the resource share. *

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource Name * (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* * * @return Specifies a list of one or more principals to associate with the resource share.

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource * Name (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

*/ public java.util.List getPrincipals() { return principals; } /** *

* Specifies a list of one or more principals to associate with the resource share. *

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource Name * (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* * * @param principals * Specifies a list of one or more principals to associate with the resource share.

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource * Name (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

*/ public void setPrincipals(java.util.Collection principals) { if (principals == null) { this.principals = null; return; } this.principals = new java.util.ArrayList(principals); } /** *

* Specifies a list of one or more principals to associate with the resource share. *

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource Name * (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPrincipals(java.util.Collection)} or {@link #withPrincipals(java.util.Collection)} if you want to * override the existing values. *

* * @param principals * Specifies a list of one or more principals to associate with the resource share.

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource * Name (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withPrincipals(String... principals) { if (this.principals == null) { setPrincipals(new java.util.ArrayList(principals.length)); } for (String ele : principals) { this.principals.add(ele); } return this; } /** *

* Specifies a list of one or more principals to associate with the resource share. *

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource Name * (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* * * @param principals * Specifies a list of one or more principals to associate with the resource share.

* You can include the following values: *

*
* An Amazon Web Services account ID, for example: 123456789012 *
*
*
* An Amazon Resource * Name (ARN) of an organization in Organizations, for example: * organizations::123456789012:organization/o-exampleorgid *
*
*
* An ARN of an organizational unit (OU) in Organizations, for example: * organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 *
*
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename *
*
*
* An ARN of an IAM user, for example: iam::123456789012user/username *
*

* *

* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide. *

* @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withPrincipals(java.util.Collection principals) { setPrincipals(principals); return this; } /** *

* Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources * associated with the resource share. *

* * @return Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the * resources associated with the resource share. */ public java.util.List getTags() { return tags; } /** *

* Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources * associated with the resource share. *

* * @param tags * Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the * resources associated with the resource share. */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources * associated with the resource share. *

* 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 one or more tags to attach to the resource share itself. It doesn't attach the tags to the * resources associated with the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

* Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources * associated with the resource share. *

* * @param tags * Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the * resources associated with the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

* * @param allowExternalPrincipals * Specifies whether principals outside your organization in Organizations can be associated with a resource * share. A value of true lets you share with individual Amazon Web Services accounts that are * not in your organization. A value of false only has meaning if your account is a * member of an Amazon Web Services Organization. The default value is true. */ public void setAllowExternalPrincipals(Boolean allowExternalPrincipals) { this.allowExternalPrincipals = allowExternalPrincipals; } /** *

* * @return Specifies whether principals outside your organization in Organizations can be associated with a resource * share. A value of true lets you share with individual Amazon Web Services accounts that are * not in your organization. A value of false only has meaning if your account is a * member of an Amazon Web Services Organization. The default value is true. */ public Boolean getAllowExternalPrincipals() { return this.allowExternalPrincipals; } /** *

* * @param allowExternalPrincipals * Specifies whether principals outside your organization in Organizations can be associated with a resource * share. A value of true lets you share with individual Amazon Web Services accounts that are * not in your organization. A value of false only has meaning if your account is a * member of an Amazon Web Services Organization. The default value is true. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withAllowExternalPrincipals(Boolean allowExternalPrincipals) { setAllowExternalPrincipals(allowExternalPrincipals); return this; } /** *

* * @return Specifies whether principals outside your organization in Organizations can be associated with a resource * share. A value of true lets you share with individual Amazon Web Services accounts that are * not in your organization. A value of false only has meaning if your account is a * member of an Amazon Web Services Organization. The default value is true. */ public Boolean isAllowExternalPrincipals() { return this.allowExternalPrincipals; } /** *

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

* * @param 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. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* 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 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. */ public String getClientToken() { return this.clientToken; } /** *

* 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 CreateResourceShareRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** *

* * @return Specifies the Amazon * Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not * specify an ARN for the permission, RAM automatically attaches the default version of the permission for * each resource type. You can associate only one permission with each resource type included in the * resource share. */ public java.util.List getPermissionArns() { return permissionArns; } /** *

* * @param permissionArns * Specifies the Amazon * Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not * specify an ARN for the permission, RAM automatically attaches the default version of the permission for * each resource type. You can associate only one permission with each resource type included in the resource * share. */ public void setPermissionArns(java.util.Collection permissionArns) { if (permissionArns == null) { this.permissionArns = null; return; } this.permissionArns = new java.util.ArrayList(permissionArns); } /** *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPermissionArns(java.util.Collection)} or {@link #withPermissionArns(java.util.Collection)} if you want * to override the existing values. *

* * @param permissionArns * Specifies the Amazon * Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not * specify an ARN for the permission, RAM automatically attaches the default version of the permission for * each resource type. You can associate only one permission with each resource type included in the resource * share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withPermissionArns(String... permissionArns) { if (this.permissionArns == null) { setPermissionArns(new java.util.ArrayList(permissionArns.length)); } for (String ele : permissionArns) { this.permissionArns.add(ele); } return this; } /** *

* * @param permissionArns * Specifies the Amazon * Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not * specify an ARN for the permission, RAM automatically attaches the default version of the permission for * each resource type. You can associate only one permission with each resource type included in the resource * share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withPermissionArns(java.util.Collection permissionArns) { setPermissionArns(permissionArns); return this; } /** *

* Specifies from which source accounts the service principal has access to the resources in this resource share. *

* * @return Specifies from which source accounts the service principal has access to the resources in this resource * share. */ public java.util.List getSources() { return sources; } /** *

* Specifies from which source accounts the service principal has access to the resources in this resource share. *

* * @param sources * Specifies from which source accounts the service principal has access to the resources in this resource * share. */ public void setSources(java.util.Collection sources) { if (sources == null) { this.sources = null; return; } this.sources = new java.util.ArrayList(sources); } /** *

* Specifies from which source accounts the service principal has access to the resources in this resource share. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSources(java.util.Collection)} or {@link #withSources(java.util.Collection)} if you want to override * the existing values. *

* Specifies from which source accounts the service principal has access to the resources in this resource share. *

* * @param sources * Specifies from which source accounts the service principal has access to the resources in this resource * share. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateResourceShareRequest withSources(java.util.Collection sources) { setSources(sources); 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 (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getResourceArns() != null) sb.append("ResourceArns: ").append(getResourceArns()).append(","); if (getPrincipals() != null) sb.append("Principals: ").append(getPrincipals()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getAllowExternalPrincipals() != null) sb.append("AllowExternalPrincipals: ").append(getAllowExternalPrincipals()).append(","); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()).append(","); if (getPermissionArns() != null) sb.append("PermissionArns: ").append(getPermissionArns()).append(","); if (getSources() != null) sb.append("Sources: ").append(getSources()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateResourceShareRequest == false) return false; CreateResourceShareRequest other = (CreateResourceShareRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getResourceArns() == null ^ this.getResourceArns() == null) return false; if (other.getResourceArns() != null && other.getResourceArns().equals(this.getResourceArns()) == false) return false; if (other.getPrincipals() == null ^ this.getPrincipals() == null) return false; if (other.getPrincipals() != null && other.getPrincipals().equals(this.getPrincipals()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getAllowExternalPrincipals() == null ^ this.getAllowExternalPrincipals() == null) return false; if (other.getAllowExternalPrincipals() != null && other.getAllowExternalPrincipals().equals(this.getAllowExternalPrincipals()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; if (other.getPermissionArns() == null ^ this.getPermissionArns() == null) return false; if (other.getPermissionArns() != null && other.getPermissionArns().equals(this.getPermissionArns()) == false) return false; if (other.getSources() == null ^ this.getSources() == null) return false; if (other.getSources() != null && other.getSources().equals(this.getSources()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getResourceArns() == null) ? 0 : getResourceArns().hashCode()); hashCode = prime * hashCode + ((getPrincipals() == null) ? 0 : getPrincipals().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getAllowExternalPrincipals() == null) ? 0 : getAllowExternalPrincipals().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); hashCode = prime * hashCode + ((getPermissionArns() == null) ? 0 : getPermissionArns().hashCode()); hashCode = prime * hashCode + ((getSources() == null) ? 0 : getSources().hashCode()); return hashCode; } @Override public CreateResourceShareRequest clone() { return (CreateResourceShareRequest) super.clone(); } }