@aws-cdk_aws-servicecatalogappregistry-alpha.AttributeGroup

class AttributeGroup (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IAttributeGroup

A Service Catalog AppRegistry Attribute Group.

Example

const attributeGroup = new appreg.AttributeGroup(this, 'MyFirstAttributeGroup', {
  attributeGroupName: 'MyFirstAttributeGroupName',
  description: 'description for my attribute group', // the description is optional,
  attributes: {
    project: 'foo',
    team: ['member1', 'member2', 'member3'],
    public: false,
    stages: {
      alpha: 'complete',
      beta: 'incomplete',
      release: 'not started'
    }
  }
});

Initializer

new AttributeGroup(scope: Construct, id: string, props: AttributeGroupProps)

Parameters

  • scope Construct
  • id string
  • props AttributeGroupProps

Construct Props

NameTypeDescription
attributeGroupName๐Ÿ”นstringEnforces a particular physical attribute group name.
attributes๐Ÿ”น{ [string]: any }A JSON of nested key-value pairs that represent the attributes in the group.
description?๐Ÿ”นstringDescription for attribute group.

attributeGroupName๐Ÿ”น

Type: string

Enforces a particular physical attribute group name.


attributes๐Ÿ”น

Type: { [string]: any }

A JSON of nested key-value pairs that represent the attributes in the group.

Attributes maybe an empty JSON '{}', but must be explicitly stated.


description?๐Ÿ”น

Type: string (optional, default: No description provided)

Description for 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.
toString()๐Ÿ”นReturns a string representation of this construct.
protected generateUniqueHash(resourceAddress)๐Ÿ”นCreate a unique hash.
protected getAttributeGroupSharePermissionARN(shareOptions)๐Ÿ”นGet the correct permission ARN based on the SharePermission.
static fromAttributeGroupArn(scope, id, attributeGroupArn)๐Ÿ”นImports an attribute group construct that represents an external attribute group.

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
  • shareOptions ShareOptions

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


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected generateUniqueHash(resourceAddress)๐Ÿ”น

protected generateUniqueHash(resourceAddress: string): string

Parameters

  • resourceAddress string

Returns

  • string

Create a unique hash.


protected getAttributeGroupSharePermissionARN(shareOptions)๐Ÿ”น

protected getAttributeGroupSharePermissionARN(shareOptions: ShareOptions): string

Parameters

  • shareOptions ShareOptions

Returns

  • string

Get the correct permission ARN based on the SharePermission.


static fromAttributeGroupArn(scope, id, attributeGroupArn)๐Ÿ”น

public static fromAttributeGroupArn(scope: Construct, id: string, attributeGroupArn: string): IAttributeGroup

Parameters

  • scope Construct โ€” The parent creating construct (usually this).
  • id string โ€” The construct's name.
  • attributeGroupArn string โ€” the Amazon Resource Name of the existing AppRegistry attribute group.

Returns

  • IAttributeGroup

Imports an attribute group construct that represents an external attribute group.