ram

Documentation

Index

• func NewResourceShare_Override(r ResourceShare, scope constructs.Construct, id *string, ...)
• func ResourceShare_ARN_FORMAT() awscdk.ArnFormat
• func ResourceShare_IsConstruct(x interface{}) *bool
• func ResourceShare_IsOwnedResource(construct constructs.IConstruct) *bool
• func ResourceShare_IsResource(construct constructs.IConstruct) *bool
• type IResourceShare
  • func ResourceShare_FromResourceShareArn(scope constructs.IConstruct, id *string, resourceShareArn *string) IResourceShare
  • func ResourceShare_FromResourceShareAttributes(scope constructs.IConstruct, id *string, attrs *ResourceShareAttributes) IResourceShare
  • func ResourceShare_FromResourceShareId(scope constructs.IConstruct, id *string, resourceShareId *string) IResourceShare
• type ISharable
• type ISharedPrincipal
• type ResourceShare
  • func NewResourceShare(scope constructs.Construct, id *string, props *ResourceShareProps) ResourceShare
• type ResourceShareAttributes
• type ResourceShareProps
• type SharedPrincipal
  • func SharedPrincipal_FromAccountId(account *string) SharedPrincipal
  • func SharedPrincipal_FromConstruct(construct constructs.IConstruct) SharedPrincipal
  • func SharedPrincipal_FromOrganizationArn(arn *string) SharedPrincipal
  • func SharedPrincipal_FromOrganizationalUnitArn(arn *string) SharedPrincipal
  • func SharedPrincipal_FromRole(role awsiam.IRole) SharedPrincipal
  • func SharedPrincipal_FromStage(stage awscdk.Stage) SharedPrincipal
  • func SharedPrincipal_FromUser(user awsiam.IUser) SharedPrincipal

Functions

func NewResourceShare_Override

func NewResourceShare_Override(r ResourceShare, scope constructs.Construct, id *string, props *ResourceShareProps)

Creates a new instance of the ResourceShare class.

func ResourceShare_ARN_FORMAT

func ResourceShare_ARN_FORMAT() awscdk.ArnFormat

func ResourceShare_IsConstruct

func ResourceShare_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func ResourceShare_IsOwnedResource

func ResourceShare_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func ResourceShare_IsResource

func ResourceShare_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type IResourceShare

type IResourceShare interface {
	awscdk.IResource
	// Adds a new principal to the resource share.
	//
	// The principal will have access to all the resources associated with the
	// resource share.
	AddPrincipal(principal ISharedPrincipal)
	// Adds a new resource to the resource share.
	//
	// The resource will be accessible to all pricipals associated with the
	// resource share.
	AddResource(resource ISharable)
	// The Amazon Resource Name (ARN) of the RAM resource share.
	ResourceShareArn() *string
	// The ID of the RAM resource share.
	ResourceShareId() *string
}

Represents an AWS Resource Access Manager (RAM) resource share in AWS.

func ResourceShare_FromResourceShareArn

func ResourceShare_FromResourceShareArn(scope constructs.IConstruct, id *string, resourceShareArn *string) IResourceShare

Imports an existing RAM resource share by specifying its Amazon Resource Name (ARN).

Returns: An object representing the imported RAM resource share.

func ResourceShare_FromResourceShareAttributes

func ResourceShare_FromResourceShareAttributes(scope constructs.IConstruct, id *string, attrs *ResourceShareAttributes) IResourceShare

Imports an existing RAM resource share by explicitly specifying its attributes.

Returns: An object representing the imported RAM resource share.

func ResourceShare_FromResourceShareId

func ResourceShare_FromResourceShareId(scope constructs.IConstruct, id *string, resourceShareId *string) IResourceShare

Imports an existing RAM resource share by specifying its AWS generated ID.

Returns: An object representing the imported RAM resource share.

type ISharable

type ISharable interface {
	// Configures resource sharing for the associated resource.
	Share(scope constructs.IConstruct) *string
}

Represents an AWS resource that can be shared via AWS Resource Access Manager (RAM).

type ISharedPrincipal

type ISharedPrincipal interface {
	Bind(scope constructs.IConstruct) *string
}

type ResourceShare

type ResourceShare interface {
	awscdk.Resource
	IResourceShare
	// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
	//
	// A value of `true`
	// lets you share with individual AWS accounts that are not in your
	// organization. A value of `false` only has meaning if your account is a
	// member of an AWS Organization.
	//
	// In order for an account to be auto discovered it must be part of the same
	// CDK application. It must also be an explicitly defined environment and not
	// environment agnostic.
	// See: [CDK Environments](https://docs.aws.amazon.com/cdk/v2/guide/environments.html)
	//
	AllowExternalPrincipals() *bool
	AutoDiscovery() *bool
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	// Specifies the name of the resource share.
	// See: [ResourceShare.Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-name)
	//
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The underlying ResourceShare CloudFormation resource.
	// See: [AWS::RAM::ResourceShare](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html)
	//
	Resource() awsram.CfnResourceShare
	// The Amazon Resource Name (ARN) of the RAM resource share.
	ResourceShareArn() *string
	// The ID of the RAM resource share.
	ResourceShareId() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// {@inheritdoc IResourceShare.addPrincipal}.
	AddPrincipal(principal ISharedPrincipal)
	// {@inheritdoc IResourceShare.addResource}.
	AddResource(resource ISharable)
	// Apply the given removal policy to this resource.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	EnableAutoDiscovery()
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

Creates a resource share that can used to share AWS resources with other AWS accounts, organizations, or organizational units (OU's). See: [AWS::RAM::ResourceShare](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html)

func NewResourceShare

func NewResourceShare(scope constructs.Construct, id *string, props *ResourceShareProps) ResourceShare

Creates a new instance of the ResourceShare class.

type ResourceShareAttributes

type ResourceShareAttributes struct {
	// The Amazon Resource Name (ARN) of the RAM resource share.
	ResourceShareArn *string `field:"optional" json:"resourceShareArn" yaml:"resourceShareArn"`
	// The ID generated by AWS for the RAM resource share.
	ResourceShareId *string `field:"optional" json:"resourceShareId" yaml:"resourceShareId"`
}

Configuration for importing an existing RAM resource share.

type ResourceShareProps

type ResourceShareProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region *string `field:"optional" json:"region" yaml:"region"`
	// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
	//
	// A value of `true`
	// lets you share with individual AWS accounts that are not in your
	// organization. A value of `false` only has meaning if your account is a
	// member of an AWS Organization.
	// See: [ResourceShare.AllowExternalPrinicpals](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-allowexternalprincipals)
	//
	AllowExternalPrincipals *bool `field:"optional" json:"allowExternalPrincipals" yaml:"allowExternalPrincipals"`
	// Controls whether the resource share should attempt to search for AWS accounts that are part of the same CDK application.
	//
	// Any accounts is finds
	// will be added to the resource automatically and will be able to use the
	// shared resources.
	AutoDiscoverAccounts *bool `field:"optional" json:"autoDiscoverAccounts" yaml:"autoDiscoverAccounts"`
	// Specifies the name of the resource share.
	// See: [ResourceShare.Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-name)
	//
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Specifies a list of one or more principals to associate with the resource share.
	// See: [ResourceShare.Prinicipals](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-principals)
	//
	Principals *[]ISharedPrincipal `field:"optional" json:"principals" yaml:"principals"`
	// Specifies a list of AWS resources to share with the configured principal accounts and organizations.
	// See: [ResourceShare.ResourceArns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-resourcearns)
	//
	Resources *[]ISharable `field:"optional" json:"resources" yaml:"resources"`
}

Configuration for ResourceShare resource.

type SharedPrincipal

type SharedPrincipal interface {
	ISharedPrincipal
	Bind(_scope constructs.IConstruct) *string
}

func SharedPrincipal_FromAccountId

func SharedPrincipal_FromAccountId(account *string) SharedPrincipal

func SharedPrincipal_FromConstruct

func SharedPrincipal_FromConstruct(construct constructs.IConstruct) SharedPrincipal

func SharedPrincipal_FromOrganizationArn

func SharedPrincipal_FromOrganizationArn(arn *string) SharedPrincipal

func SharedPrincipal_FromOrganizationalUnitArn

func SharedPrincipal_FromOrganizationalUnitArn(arn *string) SharedPrincipal

func SharedPrincipal_FromRole

func SharedPrincipal_FromRole(role awsiam.IRole) SharedPrincipal

func SharedPrincipal_FromStage

func SharedPrincipal_FromStage(stage awscdk.Stage) SharedPrincipal

func SharedPrincipal_FromUser

func SharedPrincipal_FromUser(user awsiam.IUser) SharedPrincipal