@aws-cdk_aws-servicecatalogappregistry-alpha.IAttributeGroup

interface IAttributeGroup ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalogappregistry.Alpha.IAttributeGroup
Gogithub.com/aws/aws-cdk-go/awscdkservicecatalogappregistryalpha/v2#IAttributeGroup
Javasoftware.amazon.awscdk.services.servicecatalogappregistry.alpha.IAttributeGroup
Pythonaws_cdk.aws_servicecatalogappregistry_alpha.IAttributeGroup
TypeScript (source)@aws-cdk/aws-servicecatalogappregistry-alpha ยป IAttributeGroup

Implemented by AttributeGroup

Obtainable from Application.addAttributeGroup(), AttributeGroup.fromAttributeGroupArn()

A Service Catalog AppRegistry Attribute Group.

Properties

NameTypeDescription
attributeGroupArn๐Ÿ”นstringThe ARN of the attribute group.
attributeGroupId๐Ÿ”นstringThe ID of the attribute group.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

attributeGroupArn๐Ÿ”น

Type: string

The ARN of the attribute group.


attributeGroupId๐Ÿ”น

Type: string

The ID of the attribute group.


env๐Ÿ”น

Type: ResourceEnvironment

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.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
associateWith(application)๐Ÿ”นAssociate an application with attribute group If the attribute group is already associated, it will ignore duplicate request.
shareAttributeGroup(id, shareOptions)๐Ÿ”นShare the attribute group resource with other IAM entities, accounts, or OUs.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


associateWith(application)๐Ÿ”น

public associateWith(application: IApplication): void

Parameters

  • application IApplication

Associate an application with attribute group If the attribute group is already associated, it will ignore duplicate request.


shareAttributeGroup(id, shareOptions)๐Ÿ”น

public shareAttributeGroup(id: string, shareOptions: ShareOptions): void

Parameters

  • id string โ€” The construct name for the share.
  • shareOptions ShareOptions โ€” The options for the share.

Share the attribute group resource with other IAM entities, accounts, or OUs.