awsram

Documentation

Index

• func CfnResourceShare_CFN_RESOURCE_TYPE_NAME() *string
• func CfnResourceShare_IsCfnElement(x interface{}) *bool
• func CfnResourceShare_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnResourceShare_IsConstruct(x interface{}) *bool
• func NewCfnResourceShare_Override(c CfnResourceShare, scope awscdk.Construct, id *string, ...)
• type CfnResourceShare
  • func NewCfnResourceShare(scope awscdk.Construct, id *string, props *CfnResourceShareProps) CfnResourceShare
• type CfnResourceShareProps

Functions

func CfnResourceShare_CFN_RESOURCE_TYPE_NAME

func CfnResourceShare_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceShare_IsCfnElement

func CfnResourceShare_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnResourceShare_IsCfnResource

func CfnResourceShare_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnResourceShare_IsConstruct

func CfnResourceShare_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnResourceShare_Override

func NewCfnResourceShare_Override(c CfnResourceShare, scope awscdk.Construct, id *string, props *CfnResourceShareProps)

Create a new `AWS::RAM::ResourceShare`.

Types

type CfnResourceShare

type CfnResourceShare interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AllowExternalPrincipals() interface{}
	SetAllowExternalPrincipals(val interface{})
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	PermissionArns() *[]*string
	SetPermissionArns(val *[]*string)
	Principals() *[]*string
	SetPrincipals(val *[]*string)
	Ref() *string
	ResourceArns() *[]*string
	SetResourceArns(val *[]*string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RAM::ResourceShare`.

Specifies a resource share.

TODO: EXAMPLE

func NewCfnResourceShare

func NewCfnResourceShare(scope awscdk.Construct, id *string, props *CfnResourceShareProps) CfnResourceShare

Create a new `AWS::RAM::ResourceShare`.

type CfnResourceShareProps

type CfnResourceShareProps struct {
	// Specifies the name of the resource share.
	Name *string `json:"name" yaml:"name"`
	// 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. The default value is `true` .
	AllowExternalPrincipals interface{} `json:"allowExternalPrincipals" yaml:"allowExternalPrincipals"`
	// Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS 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 *[]*string `json:"permissionArns" yaml:"permissionArns"`
	// Specifies a list of one or more principals to associate with the resource share.
	//
	// You can include the following values:
	//
	// - An AWS account ID, for example: `123456789012`
	// - An [Amazon Resoure Name (ARN)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of an organization in AWS Organizations , for example: `arn:aws:organizations::123456789012:organization/o-exampleorgid`
	// - An ARN of an organizational unit (OU) in AWS Organizations , for example: `arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
	// - An ARN of an IAM role, for example: `arn:aws:iam::123456789012:role/rolename`
	// - An ARN of an IAM user, for example: `arn:aws: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 *AWS Resource Access Manager User Guide* .
	Principals *[]*string `json:"principals" yaml:"principals"`
	// Specifies a list of one or more ARNs of the resources to associate with the resource share.
	ResourceArns *[]*string `json:"resourceArns" yaml:"resourceArns"`
	// Specifies one or more tags to attach to the resource share itself.
	//
	// It doesn't attach the tags to the resources associated with the resource share.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnResourceShare`.

TODO: EXAMPLE