ResourceShare
ram.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | ram-controller/apis/v1alpha1#ResourceShare |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | ResourceShare |
ListKind | ResourceShareList |
Plural | resourceshares |
Singular | resourceshare |
Describes a resource share in RAM.
Spec
allowExternalPrincipals: boolean
name: string
permissionARNs:
- string
permissionRefs:
from:
name: string
namespace: string
principals:
- string
resourceARNs:
- string
sources:
- string
tags:
- key: string
value: string
Field | Description |
---|---|
allowExternalPrincipals Optional | boolean Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true. |
name Required | string Specifies the name of the resource share. |
permissionARNs Optional | array Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. |
permissionARNs.[] Required | string |
permissionRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference |
type to provide more user friendly syntax for references using ‘from’ field | |
Ex: | |
APIIDRef: |
from:
name: my-api || **permissionRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| permissionRefs.[].from.name
Optional | string
|
| permissionRefs.[].from.namespace
Optional | string
|
| principals
Optional | array
Specifies a list of one or more principals to associate with the resource
share.
You can include the following values:
* An Amazon Web Services account ID, for example: 123456789012
* An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
* An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
* An ARN of an IAM user, for example: iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information,
see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
in the Resource Access Manager User Guide. |
| principals.[]
Required | string
|| resourceARNs
Optional | array
Specifies a list of one or more ARNs of the resources to associate with the
resource share. |
| resourceARNs.[]
Required | string
|| sources
Optional | array
Specifies from which source accounts the service principal has access to
the resources in this resource share. |
| sources.[]
Required | string
|| tags
Optional | array
A list of one or more tag key and value pairs. The tag key must be present
and not be an empty string. The tag value must be present but can be an empty
string. |
| tags.[]
Required | object
A structure containing a tag. A tag is metadata that you can attach to your
resources to help organize and categorize them. You can also use them to
help you secure your resources. For more information, see Controlling access
to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).
For more information about tags, see Tagging Amazon Web Services resources
(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon
Web Services General Reference Guide. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
featureSet: string
lastUpdatedTime: string
owningAccountID: string
status: string
statusMessage: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
controllers to indicate terminal states of the CR and its backend AWS | |
service API resource | |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
creationTime Optional | string The date and time when the resource share was created. |
featureSet Optional | string 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. |
lastUpdatedTime Optional | string The date and time when the resource share was last updated. |
owningAccountID Optional | string The ID of the Amazon Web Services account that owns the resource share. |
status Optional | string The current status of the resource share. |
statusMessage Optional | string A message about the status of the resource share. |