/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ram.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes a resource share in RAM. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ResourceShare implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name * (ARN) of the resource share *
*/ private String resourceShareArn; /** ** The name of the resource share. *
*/ private String name; /** ** The ID of the Amazon Web Services account that owns the resource share. *
*/ private String owningAccountId; /** ** 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.
*
* The current status of the resource share. *
*/ private String status; /** ** A message about the status of the resource share. *
*/ private String statusMessage; /** ** The tag key and value pairs attached to the resource share. *
*/ private java.util.List* The date and time when the resource share was created. *
*/ private java.util.Date creationTime; /** ** The date and time when the resource share was last updated. *
*/ private java.util.Date lastUpdatedTime; /** ** 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.
*
* The Amazon Resource Name * (ARN) of the resource share *
* * @param resourceShareArn * The Amazon Resource * Name (ARN) of the resource share */ public void setResourceShareArn(String resourceShareArn) { this.resourceShareArn = resourceShareArn; } /** ** The Amazon Resource Name * (ARN) of the resource share *
* * @return The Amazon Resource * Name (ARN) of the resource share */ public String getResourceShareArn() { return this.resourceShareArn; } /** ** The Amazon Resource Name * (ARN) of the resource share *
* * @param resourceShareArn * The Amazon Resource * Name (ARN) of the resource share * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withResourceShareArn(String resourceShareArn) { setResourceShareArn(resourceShareArn); return this; } /** ** The name of the resource share. *
* * @param name * The name of the resource share. */ public void setName(String name) { this.name = name; } /** ** The name of the resource share. *
* * @return The name of the resource share. */ public String getName() { return this.name; } /** ** The name of the resource share. *
* * @param name * The name of the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withName(String name) { setName(name); return this; } /** ** The ID of the Amazon Web Services account that owns the resource share. *
* * @param owningAccountId * The ID of the Amazon Web Services account that owns the resource share. */ public void setOwningAccountId(String owningAccountId) { this.owningAccountId = owningAccountId; } /** ** The ID of the Amazon Web Services account that owns the resource share. *
* * @return The ID of the Amazon Web Services account that owns the resource share. */ public String getOwningAccountId() { return this.owningAccountId; } /** ** The ID of the Amazon Web Services account that owns the resource share. *
* * @param owningAccountId * The ID of the Amazon Web Services account that owns the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withOwningAccountId(String owningAccountId) { setOwningAccountId(owningAccountId); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* The current status of the resource share. *
* * @param status * The current status of the resource share. * @see ResourceShareStatus */ public void setStatus(String status) { this.status = status; } /** ** The current status of the resource share. *
* * @return The current status of the resource share. * @see ResourceShareStatus */ public String getStatus() { return this.status; } /** ** The current status of the resource share. *
* * @param status * The current status of the resource share. * @return Returns a reference to this object so that method calls can be chained together. * @see ResourceShareStatus */ public ResourceShare withStatus(String status) { setStatus(status); return this; } /** ** The current status of the resource share. *
* * @param status * The current status of the resource share. * @return Returns a reference to this object so that method calls can be chained together. * @see ResourceShareStatus */ public ResourceShare withStatus(ResourceShareStatus status) { this.status = status.toString(); return this; } /** ** A message about the status of the resource share. *
* * @param statusMessage * A message about the status of the resource share. */ public void setStatusMessage(String statusMessage) { this.statusMessage = statusMessage; } /** ** A message about the status of the resource share. *
* * @return A message about the status of the resource share. */ public String getStatusMessage() { return this.statusMessage; } /** ** A message about the status of the resource share. *
* * @param statusMessage * A message about the status of the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withStatusMessage(String statusMessage) { setStatusMessage(statusMessage); return this; } /** ** The tag key and value pairs attached to the resource share. *
* * @return The tag key and value pairs attached to the resource share. */ public java.util.List* The tag key and value pairs attached to the resource share. *
* * @param tags * The tag key and value pairs attached to the resource share. */ public void setTags(java.util.Collection* The tag key and value pairs attached to the resource share. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * The tag key and value pairs attached to the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* The tag key and value pairs attached to the resource share. *
* * @param tags * The tag key and value pairs attached to the resource share. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withTags(java.util.Collection* The date and time when the resource share was created. *
* * @param creationTime * The date and time when the resource share was created. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** ** The date and time when the resource share was created. *
* * @return The date and time when the resource share was created. */ public java.util.Date getCreationTime() { return this.creationTime; } /** ** The date and time when the resource share was created. *
* * @param creationTime * The date and time when the resource share was created. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** ** The date and time when the resource share was last updated. *
* * @param lastUpdatedTime * The date and time when the resource share was last updated. */ public void setLastUpdatedTime(java.util.Date lastUpdatedTime) { this.lastUpdatedTime = lastUpdatedTime; } /** ** The date and time when the resource share was last updated. *
* * @return The date and time when the resource share was last updated. */ public java.util.Date getLastUpdatedTime() { return this.lastUpdatedTime; } /** ** The date and time when the resource share was last updated. *
* * @param lastUpdatedTime * The date and time when the resource share was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public ResourceShare withLastUpdatedTime(java.util.Date lastUpdatedTime) { setLastUpdatedTime(lastUpdatedTime); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*