Skip to content

ResourceShare

Source code in docs_src/capo_ram/types/resource_share.py
class ResourceShare(TypedDict, closed=True):
    resource_share_arn: NotRequired["capo_ram.types.string.String"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share</p>"""
    name: NotRequired["capo_ram.types.string.String"]
    """<p>The name of the resource share.</p>"""
    owning_account_id: NotRequired["capo_ram.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the resource share.</p>"""
    allow_external_principals: NotRequired["capo_ram.types.boolean.Boolean"]
    """<p>Indicates whether principals outside your organization in Organizations can be associated with a resource share.</p> <ul> <li> <p> <code>True</code> – the resource share can be shared with any Amazon Web Services account.</p> </li> <li> <p> <code>False</code> – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.</p> </li> </ul>"""
    status: NotRequired["capo_ram.types.resource_share_status.ResourceShareStatus"]
    """<p>The current status of the resource share.</p>"""
    status_message: NotRequired["capo_ram.types.string.String"]
    """<p>A message about the status of the resource share.</p>"""
    tags: NotRequired["capo_ram.types.tag_list.TagList"]
    """<p>The tag key and value pairs attached to the resource share.</p>"""
    creation_time: NotRequired["capo_ram.types.date_time.DateTime"]
    """<p>The date and time when the resource share was created.</p>"""
    last_updated_time: NotRequired["capo_ram.types.date_time.DateTime"]
    """<p>The date and time when the resource share was last updated.</p>"""
    feature_set: NotRequired[
        "capo_ram.types.resource_share_feature_set.ResourceShareFeatureSet"
    ]
    """<p>Indicates what features are available for this resource share. This parameter can have one of the following values:</p> <ul> <li> <p> <b>STANDARD</b> – 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 <b>CREATED_FROM_POLICY</b> and then promoted.</p> </li> <li> <p> <b>CREATED_FROM_POLICY</b> – 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 <a>PromoteResourceShareCreatedFromPolicy</a>.</p> </li> <li> <p> <b>PROMOTING_TO_STANDARD</b> – This resource share was originally <code>CREATED_FROM_POLICY</code>, but the customer ran the <a>PromoteResourceShareCreatedFromPolicy</a> and that operation is still in progress. This value changes to <code>STANDARD</code> when complete.</p> </li> </ul>"""
    resource_share_configuration: NotRequired[
        "capo_ram.types.resource_share_configuration.ResourceShareConfiguration"
    ]
    """<p>The configuration of the resource share</p>"""

allow_external_principals instance-attribute

allow_external_principals: NotRequired[Boolean]

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.

creation_time instance-attribute

creation_time: NotRequired[DateTime]

The date and time when the resource share was created.

feature_set instance-attribute

feature_set: NotRequired[ResourceShareFeatureSet]

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.

last_updated_time instance-attribute

last_updated_time: NotRequired[DateTime]

The date and time when the resource share was last updated.

name instance-attribute

name: NotRequired[String]

The name of the resource share.

owning_account_id instance-attribute

owning_account_id: NotRequired[String]

The ID of the Amazon Web Services account that owns the resource share.

resource_share_arn instance-attribute

resource_share_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the resource share

resource_share_configuration instance-attribute

resource_share_configuration: NotRequired[ResourceShareConfiguration]

The configuration of the resource share

status instance-attribute

status: NotRequired[ResourceShareStatus]

The current status of the resource share.

status_message instance-attribute

status_message: NotRequired[String]

A message about the status of the resource share.

tags instance-attribute

tags: NotRequired[TagList]

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