com.amazonaws.services.ram.model

Class CreateResourceShareRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.CreateResourceShareRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateResourceShareRequest
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
CreateResourceShareRequest()

Method Summary

Modifier and Type	Method and Description
CreateResourceShareRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAllowExternalPrincipals() Specifies whether principals outside your organization in Organizations can be associated with a resource share.
String	getClientToken() Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getName() Specifies the name of the resource share.
List<String>	getPermissionArns() Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share.
List<String>	getPrincipals() Specifies a list of one or more principals to associate with the resource share.
List<String>	getResourceArns() Specifies a list of one or more ARNs of the resources to associate with the resource share.
List<String>	getSources() Specifies from which source accounts the service principal has access to the resources in this resource share.
List<Tag>	getTags() Specifies one or more tags to attach to the resource share itself.
int	hashCode()
Boolean	isAllowExternalPrincipals() Specifies whether principals outside your organization in Organizations can be associated with a resource share.
void	setAllowExternalPrincipals(Boolean allowExternalPrincipals) Specifies whether principals outside your organization in Organizations can be associated with a resource share.
void	setClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setName(String name) Specifies the name of the resource share.
void	setPermissionArns(Collection<String> permissionArns) Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share.
void	setPrincipals(Collection<String> principals) Specifies a list of one or more principals to associate with the resource share.
void	setResourceArns(Collection<String> resourceArns) Specifies a list of one or more ARNs of the resources to associate with the resource share.
void	setSources(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
void	setTags(Collection<Tag> tags) Specifies one or more tags to attach to the resource share itself.
String	toString() Returns a string representation of this object.
CreateResourceShareRequest	withAllowExternalPrincipals(Boolean allowExternalPrincipals) Specifies whether principals outside your organization in Organizations can be associated with a resource share.
CreateResourceShareRequest	withClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateResourceShareRequest	withName(String name) Specifies the name of the resource share.
CreateResourceShareRequest	withPermissionArns(Collection<String> permissionArns) Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share.
CreateResourceShareRequest	withPermissionArns(String... permissionArns) Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share.
CreateResourceShareRequest	withPrincipals(Collection<String> principals) Specifies a list of one or more principals to associate with the resource share.
CreateResourceShareRequest	withPrincipals(String... principals) Specifies a list of one or more principals to associate with the resource share.
CreateResourceShareRequest	withResourceArns(Collection<String> resourceArns) Specifies a list of one or more ARNs of the resources to associate with the resource share.
CreateResourceShareRequest	withResourceArns(String... resourceArns) Specifies a list of one or more ARNs of the resources to associate with the resource share.
CreateResourceShareRequest	withSources(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
CreateResourceShareRequest	withSources(String... sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
CreateResourceShareRequest	withTags(Collection<Tag> tags) Specifies one or more tags to attach to the resource share itself.
CreateResourceShareRequest	withTags(Tag... tags) Specifies one or more tags to attach to the resource share itself.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateResourceShareRequest

public CreateResourceShareRequest()

Method Detail

setName

public void setName(String name)

Specifies the name of the resource share.

Parameters:

name - Specifies the name of the resource share.

getName

public String getName()

Specifies the name of the resource share.

Returns:

Specifies the name of the resource share.

withName

public CreateResourceShareRequest withName(String name)

Specifies the name of the resource share.

Parameters:

name - Specifies the name of the resource share.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResourceArns

public List<String> getResourceArns()

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

Returns:

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

setResourceArns

public void setResourceArns(Collection<String> resourceArns)

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

Parameters:

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

withResourceArns

public CreateResourceShareRequest withResourceArns(String... 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 setResourceArns(java.util.Collection) or withResourceArns(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourceArns

public CreateResourceShareRequest withResourceArns(Collection<String> resourceArns)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getPrincipals

public List<String> getPrincipals()

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.

Returns:

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.

setPrincipals

public void setPrincipals(Collection<String> 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.

Parameters:

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.

withPrincipals

public CreateResourceShareRequest withPrincipals(String... 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 setPrincipals(java.util.Collection) or withPrincipals(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPrincipals

public CreateResourceShareRequest withPrincipals(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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.

Returns:

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.

setTags

public void setTags(Collection<Tag> 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.

Parameters:

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.

withTags

public CreateResourceShareRequest withTags(Tag... 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 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateResourceShareRequest withTags(Collection<Tag> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllowExternalPrincipals

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

Parameters:

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.

getAllowExternalPrincipals

public Boolean getAllowExternalPrincipals()

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.

Returns:

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.

withAllowExternalPrincipals

public CreateResourceShareRequest withAllowExternalPrincipals(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAllowExternalPrincipals

public Boolean isAllowExternalPrincipals()

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.

Returns:

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.

setClientToken

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

Parameters:

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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public CreateResourceShareRequest withClientToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPermissionArns

public List<String> getPermissionArns()

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.

Returns:

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.

setPermissionArns

public void setPermissionArns(Collection<String> 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.

Parameters:

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.

withPermissionArns

public CreateResourceShareRequest withPermissionArns(String... 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.

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPermissionArns

public CreateResourceShareRequest withPermissionArns(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSources

public List<String> getSources()

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

Returns:

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

setSources

public void setSources(Collection<String> sources)

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

Parameters:

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

withSources

public CreateResourceShareRequest withSources(String... 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 setSources(java.util.Collection) or withSources(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSources

public CreateResourceShareRequest withSources(Collection<String> sources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()