com.amazonaws.services.ram.model

Class AssociateResourceShareRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.AssociateResourceShareRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
AssociateResourceShareRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
List<String>	getPrincipals() Specifies a list of principals to whom you want to the resource share.
List<String>	getResourceArns() Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
String	getResourceShareArn() Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
List<String>	getSources() Specifies from which source accounts the service principal has access to the resources in this resource share.
int	hashCode()
void	setClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setPrincipals(Collection<String> principals) Specifies a list of principals to whom you want to the resource share.
void	setResourceArns(Collection<String> resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
void	setResourceShareArn(String resourceShareArn) Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
void	setSources(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
String	toString() Returns a string representation of this object.
AssociateResourceShareRequest	withClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AssociateResourceShareRequest	withPrincipals(Collection<String> principals) Specifies a list of principals to whom you want to the resource share.
AssociateResourceShareRequest	withPrincipals(String... principals) Specifies a list of principals to whom you want to the resource share.
AssociateResourceShareRequest	withResourceArns(Collection<String> resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
AssociateResourceShareRequest	withResourceArns(String... resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
AssociateResourceShareRequest	withResourceShareArn(String resourceShareArn) Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
AssociateResourceShareRequest	withSources(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
AssociateResourceShareRequest	withSources(String... sources) Specifies from which source accounts the service principal has access to the resources in this resource share.

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

AssociateResourceShareRequest

public AssociateResourceShareRequest()

Method Detail

setResourceShareArn

public void setResourceShareArn(String resourceShareArn)

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Parameters:

resourceShareArn - Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

getResourceShareArn

public String getResourceShareArn()

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Returns:

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

withResourceShareArn

public AssociateResourceShareRequest withResourceShareArn(String resourceShareArn)

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Parameters:

resourceShareArn - Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Returns:

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

getResourceArns

public List<String> getResourceArns()

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Returns:

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

setResourceArns

public void setResourceArns(Collection<String> resourceArns)

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Parameters:

resourceArns - Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

withResourceArns

public AssociateResourceShareRequest withResourceArns(String... resourceArns)

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

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 Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Returns:

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

withResourceArns

public AssociateResourceShareRequest withResourceArns(Collection<String> resourceArns)

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Parameters:

resourceArns - Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Returns:

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

getPrincipals

public List<String> getPrincipals()

Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 AssociateResourceShareRequest withPrincipals(String... principals)

Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 AssociateResourceShareRequest withPrincipals(Collection<String> principals)

Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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 principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

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.

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

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 AssociateResourceShareRequest 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 AssociateResourceShareRequest 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 AssociateResourceShareRequest 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()