ResourceShare (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ram.model.ResourceShare

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ResourceShare.Builder,ResourceShare>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResourceShare
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceShare.Builder,ResourceShare>

Describes a resource share in RAM.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ResourceShare.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ResourceShare.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowExternalPrincipals()` Indicates whether principals outside your organization in Organizations can be associated with a resource share.
`static ResourceShare.Builder`	`builder()`
`Instant`	`creationTime()` The date and time when the resource share was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ResourceShareFeatureSet`	`featureSet()` Indicates what features are available for this resource share.
`String`	`featureSetAsString()` Indicates what features are available for this resource share.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Instant`	`lastUpdatedTime()` The date and time when the resource share was last updated.
`String`	`name()` The name of the resource share.
`String`	`owningAccountId()` The ID of the Amazon Web Services account that owns the resource share.
`String`	`resourceShareArn()` The Amazon Resource Name (ARN) of the resource share
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ResourceShare.Builder>`	`serializableBuilderClass()`
`ResourceShareStatus`	`status()` The current status of the resource share.
`String`	`statusAsString()` The current status of the resource share.
`String`	`statusMessage()` A message about the status of the resource share.
`List<Tag>`	`tags()` The tag key and value pairs attached to the resource share.
`ResourceShare.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - resourceShareArn
```
public final String resourceShareArn()
```
    The Amazon Resource Name (ARN) of the resource share
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource share
  - name
```
public final String name()
```
    The name of the resource share.
    
    Returns:
    
    The name of the resource share.
  - owningAccountId
```
public final String owningAccountId()
```
    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.
  - allowExternalPrincipals
```
public final 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.
    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.
  - status
```
public final ResourceShareStatus status()
```
    The current status of the resource share.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the resource share.
    
    See Also:
    
    ResourceShareStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the resource share.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the resource share.
    
    See Also:
    
    ResourceShareStatus
  - statusMessage
```
public final String statusMessage()
```
    A message about the status of the resource share.
    
    Returns:
    
    A message about the status of the resource share.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The tag key and value pairs attached to the resource share.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tag key and value pairs attached to the resource share.
  - creationTime
```
public final Instant creationTime()
```
    The date and time when the resource share was created.
    
    Returns:
    
    The date and time when the resource share was created.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    The date and time when the resource share was last updated.
    
    Returns:
    
    The date and time when the resource share was last updated.
  - featureSet
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, featureSet will return ResourceShareFeatureSet.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureSetAsString().
    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
  - featureSetAsString
```
public final String featureSetAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, featureSet will return ResourceShareFeatureSet.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureSetAsString().
    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
  - toBuilder
```
public ResourceShare.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ResourceShare.Builder,ResourceShare>
  - builder
```
public static ResourceShare.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ResourceShare.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ResourceShare

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resourceShareArn

name

owningAccountId

allowExternalPrincipals

status

statusAsString

statusMessage

hasTags

tags

creationTime

lastUpdatedTime

featureSet

featureSetAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields