software.amazon.awssdk.services.ram.model

Interface ResourceShare.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ResourceShare.Builder,ResourceShare>, SdkBuilder<ResourceShare.Builder,ResourceShare>, SdkPojo

Enclosing class:

ResourceShare

public static interface ResourceShare.Builder
extends SdkPojo, CopyableBuilder<ResourceShare.Builder,ResourceShare>

Method Summary

Modifier and Type	Method and Description
ResourceShare.Builder	allowExternalPrincipals(Boolean allowExternalPrincipals) Indicates whether principals outside your organization in Organizations can be associated with a resource share.
ResourceShare.Builder	creationTime(Instant creationTime) The date and time when the resource share was created.
ResourceShare.Builder	featureSet(ResourceShareFeatureSet featureSet) Indicates what features are available for this resource share.
ResourceShare.Builder	featureSet(String featureSet) Indicates what features are available for this resource share.
ResourceShare.Builder	lastUpdatedTime(Instant lastUpdatedTime) The date and time when the resource share was last updated.
ResourceShare.Builder	name(String name) The name of the resource share.
ResourceShare.Builder	owningAccountId(String owningAccountId) The ID of the Amazon Web Services account that owns the resource share.
ResourceShare.Builder	resourceShareArn(String resourceShareArn) The Amazon Resource Name (ARN) of the resource share
ResourceShare.Builder	status(ResourceShareStatus status) The current status of the resource share.
ResourceShare.Builder	status(String status) The current status of the resource share.
ResourceShare.Builder	statusMessage(String statusMessage) A message about the status of the resource share.
ResourceShare.Builder	tags(Collection<Tag> tags) The tag key and value pairs attached to the resource share.
ResourceShare.Builder	tags(Consumer<Tag.Builder>... tags) The tag key and value pairs attached to the resource share.
ResourceShare.Builder	tags(Tag... tags) The tag key and value pairs attached to the resource share.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

resourceShareArn

ResourceShare.Builder resourceShareArn(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.

name

ResourceShare.Builder name(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.

owningAccountId

ResourceShare.Builder owningAccountId(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.

allowExternalPrincipals

ResourceShare.Builder allowExternalPrincipals(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.

status

ResourceShare.Builder status(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, ResourceShareStatus

status

ResourceShare.Builder status(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, ResourceShareStatus

statusMessage

ResourceShare.Builder statusMessage(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.

tags

ResourceShare.Builder tags(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.

tags

ResourceShare.Builder tags(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.

tags

ResourceShare.Builder tags(Consumer<Tag.Builder>... tags)

The tag key and value pairs attached to the resource share.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

creationTime

ResourceShare.Builder creationTime(Instant 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.

lastUpdatedTime

ResourceShare.Builder lastUpdatedTime(Instant 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.

featureSet

ResourceShare.Builder featureSet(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, ResourceShareFeatureSet

featureSet

ResourceShare.Builder featureSet(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, ResourceShareFeatureSet