ResourceShare (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ram.model.ResourceShare

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResourceShare
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a resource share in RAM.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResourceShare()

Constructors
Constructor and Description
`ResourceShare()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceShare`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowExternalPrincipals()` Indicates whether principals outside your organization in Organizations can be associated with a resource share.
`Date`	`getCreationTime()` The date and time when the resource share was created.
`String`	`getFeatureSet()` Indicates what features are available for this resource share.
`Date`	`getLastUpdatedTime()` The date and time when the resource share was last updated.
`String`	`getName()` The name of the resource share.
`String`	`getOwningAccountId()` The ID of the Amazon Web Services account that owns the resource share.
`String`	`getResourceShareArn()` The Amazon Resource Name (ARN) of the resource share
`String`	`getStatus()` The current status of the resource share.
`String`	`getStatusMessage()` A message about the status of the resource share.
`List<Tag>`	`getTags()` The tag key and value pairs attached to the resource share.
`int`	`hashCode()`
`Boolean`	`isAllowExternalPrincipals()` Indicates whether principals outside your organization in Organizations can be associated with a resource share.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowExternalPrincipals(Boolean allowExternalPrincipals)` Indicates whether principals outside your organization in Organizations can be associated with a resource share.
`void`	`setCreationTime(Date creationTime)` The date and time when the resource share was created.
`void`	`setFeatureSet(String featureSet)` Indicates what features are available for this resource share.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The date and time when the resource share was last updated.
`void`	`setName(String name)` The name of the resource share.
`void`	`setOwningAccountId(String owningAccountId)` The ID of the Amazon Web Services account that owns the resource share.
`void`	`setResourceShareArn(String resourceShareArn)` The Amazon Resource Name (ARN) of the resource share
`void`	`setStatus(String status)` The current status of the resource share.
`void`	`setStatusMessage(String statusMessage)` A message about the status of the resource share.
`void`	`setTags(Collection<Tag> tags)` The tag key and value pairs attached to the resource share.
`String`	`toString()` Returns a string representation of this object.
`ResourceShare`	`withAllowExternalPrincipals(Boolean allowExternalPrincipals)` Indicates whether principals outside your organization in Organizations can be associated with a resource share.
`ResourceShare`	`withCreationTime(Date creationTime)` The date and time when the resource share was created.
`ResourceShare`	`withFeatureSet(ResourceShareFeatureSet featureSet)` Indicates what features are available for this resource share.
`ResourceShare`	`withFeatureSet(String featureSet)` Indicates what features are available for this resource share.
`ResourceShare`	`withLastUpdatedTime(Date lastUpdatedTime)` The date and time when the resource share was last updated.
`ResourceShare`	`withName(String name)` The name of the resource share.
`ResourceShare`	`withOwningAccountId(String owningAccountId)` The ID of the Amazon Web Services account that owns the resource share.
`ResourceShare`	`withResourceShareArn(String resourceShareArn)` The Amazon Resource Name (ARN) of the resource share
`ResourceShare`	`withStatus(ResourceShareStatus status)` The current status of the resource share.
`ResourceShare`	`withStatus(String status)` The current status of the resource share.
`ResourceShare`	`withStatusMessage(String statusMessage)` A message about the status of the resource share.
`ResourceShare`	`withTags(Collection<Tag> tags)` The tag key and value pairs attached to the resource share.
`ResourceShare`	`withTags(Tag... tags)` The tag key and value pairs attached to the resource share.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ResourceShare
```
public ResourceShare()
```
- Method Detail
  - setResourceShareArn
```
public void setResourceShareArn(String resourceShareArn)
```
    The Amazon Resource Name (ARN) of the resource share
    
    Parameters:
    
    resourceShareArn - The Amazon Resource Name (ARN) of the resource share
  - getResourceShareArn
```
public String getResourceShareArn()
```
    The Amazon Resource Name (ARN) of the resource share
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource share
  - withResourceShareArn
```
public ResourceShare withResourceShareArn(String resourceShareArn)
```
    The Amazon Resource Name (ARN) of the resource share
    
    Parameters:
    
    resourceShareArn - The Amazon Resource Name (ARN) of the resource share
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the resource share.
    
    Parameters:
    
    name - The name of the resource share.
  - getName
```
public String getName()
```
    The name of the resource share.
    
    Returns:
    
    The name of the resource share.
  - withName
```
public ResourceShare withName(String name)
```
    The name of the resource share.
    
    Parameters:
    
    name - The name of the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwningAccountId
```
public void setOwningAccountId(String owningAccountId)
```
    The ID of the Amazon Web Services account that owns the resource share.
    
    Parameters:
    
    owningAccountId - The ID of the Amazon Web Services account that owns the resource share.
  - getOwningAccountId
```
public String getOwningAccountId()
```
    The ID of the Amazon Web Services account that owns the resource share.
    
    Returns:
    
    The ID of the Amazon Web Services account that owns the resource share.
  - withOwningAccountId
```
public ResourceShare withOwningAccountId(String owningAccountId)
```
    The ID of the Amazon Web Services account that owns the resource share.
    
    Parameters:
    
    owningAccountId - The ID of the Amazon Web Services account that owns the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowExternalPrincipals
```
public void setAllowExternalPrincipals(Boolean allowExternalPrincipals)
```
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    Parameters:
    allowExternalPrincipals - Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    True – the resource share can be shared with any Amazon Web Services account.
    
    False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
  - getAllowExternalPrincipals
```
public Boolean getAllowExternalPrincipals()
```
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    Returns:
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    True – the resource share can be shared with any Amazon Web Services account.
    
    False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
  - withAllowExternalPrincipals
```
public ResourceShare withAllowExternalPrincipals(Boolean allowExternalPrincipals)
```
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    Parameters:
    allowExternalPrincipals - Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    True – the resource share can be shared with any Amazon Web Services account.
    
    False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowExternalPrincipals
```
public Boolean isAllowExternalPrincipals()
```
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    Returns:
    Indicates whether principals outside your organization in Organizations can be associated with a resource share.
    
    True – the resource share can be shared with any Amazon Web Services account.
    
    False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the resource share.
    
    Parameters:
    
    status - The current status of the resource share.
    
    See Also:
    
    ResourceShareStatus
  - getStatus
```
public String getStatus()
```
    The current status of the resource share.
    
    Returns:
    
    The current status of the resource share.
    
    See Also:
    
    ResourceShareStatus
  - withStatus
```
public ResourceShare withStatus(String status)
```
    The current status of the resource share.
    
    Parameters:
    
    status - The current status of the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceShareStatus
  - withStatus
```
public ResourceShare withStatus(ResourceShareStatus status)
```
    The current status of the resource share.
    
    Parameters:
    
    status - The current status of the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceShareStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A message about the status of the resource share.
    
    Parameters:
    
    statusMessage - A message about the status of the resource share.
  - getStatusMessage
```
public String getStatusMessage()
```
    A message about the status of the resource share.
    
    Returns:
    
    A message about the status of the resource share.
  - withStatusMessage
```
public ResourceShare withStatusMessage(String statusMessage)
```
    A message about the status of the resource share.
    
    Parameters:
    
    statusMessage - A message about the status of the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tag key and value pairs attached to the resource share.
    
    Returns:
    
    The tag key and value pairs attached to the resource share.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tag key and value pairs attached to the resource share.
    
    Parameters:
    
    tags - The tag key and value pairs attached to the resource share.
  - withTags
```
public ResourceShare withTags(Tag... tags)
```
    The tag key and value pairs attached to 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 - The tag key and value pairs attached to the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public ResourceShare withTags(Collection<Tag> tags)
```
    The tag key and value pairs attached to the resource share.
    
    Parameters:
    
    tags - The tag key and value pairs attached to the resource share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time when the resource share was created.
    
    Parameters:
    
    creationTime - The date and time when the resource share was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time when the resource share was created.
    
    Returns:
    
    The date and time when the resource share was created.
  - withCreationTime
```
public ResourceShare withCreationTime(Date creationTime)
```
    The date and time when the resource share was created.
    
    Parameters:
    
    creationTime - The date and time when the resource share was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The date and time when the resource share was last updated.
    
    Parameters:
    
    lastUpdatedTime - The date and time when the resource share was last updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The date and time when the resource share was last updated.
    
    Returns:
    
    The date and time when the resource share was last updated.
  - withLastUpdatedTime
```
public ResourceShare withLastUpdatedTime(Date lastUpdatedTime)
```
    The date and time when the resource share was last updated.
    
    Parameters:
    
    lastUpdatedTime - The date and time when the resource share was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFeatureSet
```
public void setFeatureSet(String featureSet)
```
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Parameters:
    featureSet - Indicates what features are available for this resource share. This parameter can have one of the following values:
    
    STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    
    CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    See Also:
    
    ResourceShareFeatureSet
  - getFeatureSet
```
public String getFeatureSet()
```
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Returns:
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    
    STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    
    CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    See Also:
    
    ResourceShareFeatureSet
  - withFeatureSet
```
public ResourceShare withFeatureSet(String featureSet)
```
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Parameters:
    featureSet - Indicates what features are available for this resource share. This parameter can have one of the following values:
    
    STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    
    CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceShareFeatureSet
  - withFeatureSet
```
public ResourceShare withFeatureSet(ResourceShareFeatureSet featureSet)
```
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Parameters:
    featureSet - Indicates what features are available for this resource share. This parameter can have one of the following values:
    
    STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    
    CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    
    PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceShareFeatureSet
  - 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 ResourceShare clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class ResourceShare

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourceShare

Method Detail

setResourceShareArn

getResourceShareArn

withResourceShareArn

setName

getName

withName

setOwningAccountId

getOwningAccountId

withOwningAccountId

setAllowExternalPrincipals

getAllowExternalPrincipals

withAllowExternalPrincipals

isAllowExternalPrincipals

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

getTags

setTags

withTags

withTags

setCreationTime

getCreationTime

withCreationTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setFeatureSet

getFeatureSet

withFeatureSet

withFeatureSet

toString

equals

hashCode

clone

marshall