ram

Documentation

Index

• func NewResourceShare_Override(r ResourceShare, scope constructs.Construct, id *string, ...)
• func ResourceShare_IsConstruct(x interface{}) *bool
• func ResourceShare_IsOwnedResource(construct constructs.IConstruct) *bool
• func ResourceShare_IsResource(construct constructs.IConstruct) *bool
• type ISharedPrincipal
• type ISharedResource
• type ResourceShare
  • func NewResourceShare(scope constructs.Construct, id *string, props *ResourceShareProps) ResourceShare
• 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
• type SharedResource
  • func SharedResource_FromArn(arn *string) SharedResource
  • func SharedResource_FromProject(project awscodebuild.IProject) SharedResource
  • func SharedResource_FromSubnet(subnet awsec2.ISubnet) SharedResource

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_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 ISharedPrincipal

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

type ISharedResource

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

type ResourceShare

type ResourceShare interface {
	awscdk.Resource
	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
	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
	Resource() awsram.CfnResourceShare
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	AddPrincipal(principal ISharedPrincipal)
	AddResource(resource ISharedResource)
	// 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
}

func NewResourceShare

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

Creates a new instance of the ResourceShare class.

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"`
	AllowExternalPrincipals *bool               `field:"optional" json:"allowExternalPrincipals" yaml:"allowExternalPrincipals"`
	AutoDiscoverAccounts    *bool               `field:"optional" json:"autoDiscoverAccounts" yaml:"autoDiscoverAccounts"`
	Name                    *string             `field:"optional" json:"name" yaml:"name"`
	Principals              *[]ISharedPrincipal `field:"optional" json:"principals" yaml:"principals"`
	Resources               *[]ISharedResource  `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

type SharedResource

type SharedResource interface {
	ISharedResource
	Bind(_scope constructs.IConstruct) *string
}

func SharedResource_FromArn

func SharedResource_FromArn(arn *string) SharedResource

func SharedResource_FromProject

func SharedResource_FromProject(project awscodebuild.IProject) SharedResource

func SharedResource_FromSubnet

func SharedResource_FromSubnet(subnet awsec2.ISubnet) SharedResource