Package software.amazon.awscdk.services.servicecatalogappregistry.alpha

Class AttributeGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.servicecatalogappregistry.alpha.AttributeGroup

All Implemented Interfaces:

IResource, IAttributeGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:43:00.404Z")
@Stability(Experimental)
public class AttributeGroup
extends Resource
implements IAttributeGroup

(experimental) A Service Catalog AppRegistry Attribute Group.

Example:

 AttributeGroup attributeGroup = AttributeGroup.Builder.create(this, "MyFirstAttributeGroup")
         .attributeGroupName("MyFirstAttributeGroupName")
         .description("description for my attribute group") // the description is optional,
         .attributes(Map.of(
                 "project", "foo",
                 "team", List.of("member1", "member2", "member3"),
                 "public", false,
                 "stages", Map.of(
                         "alpha", "complete",
                         "beta", "incomplete",
                         "release", "not started")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AttributeGroup.Builder	(experimental) A fluent builder for AttributeGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalogappregistry.alpha.IAttributeGroup

IAttributeGroup.Jsii$Default, IAttributeGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AttributeGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AttributeGroup(software.amazon.jsii.JsiiObjectRef objRef)
	AttributeGroup(software.constructs.Construct scope, String id, AttributeGroupProps props)

Method Summary

Modifier and Type	Method	Description
void	associateWith(IApplication application)	(experimental) Associate an application with attribute group If the attribute group is already associated, it will ignore duplicate request.
static IAttributeGroup	fromAttributeGroupArn(software.constructs.Construct scope, String id, String attributeGroupArn)	(experimental) Imports an attribute group construct that represents an external attribute group.
protected String	generateUniqueHash(String resourceAddress)	(experimental) Create a unique hash.
String	getAttributeGroupArn()	(experimental) The ARN of the attribute group.
String	getAttributeGroupId()	(experimental) The ID of the attribute group.
protected String	getAttributeGroupSharePermissionARN(ShareOptions shareOptions)	(experimental) Get the correct permission ARN based on the SharePermission.
void	shareAttributeGroup(String id, ShareOptions shareOptions)	(experimental) Share the attribute group resource with other IAM entities, accounts, or OUs.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AttributeGroup

protected AttributeGroup(software.amazon.jsii.JsiiObjectRef objRef)

AttributeGroup

protected AttributeGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AttributeGroup

@Stability(Experimental)
public AttributeGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AttributeGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromAttributeGroupArn

@Stability(Experimental)
@NotNull
public static IAttributeGroup fromAttributeGroupArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String attributeGroupArn)

(experimental) Imports an attribute group construct that represents an external attribute group.

Parameters:

scope - The parent creating construct (usually this). This parameter is required.

id - The construct's name. This parameter is required.

attributeGroupArn - the Amazon Resource Name of the existing AppRegistry attribute group. This parameter is required.

associateWith

@Stability(Experimental)
public void associateWith(@NotNull
 IApplication application)

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

Specified by:

associateWith in interface IAttributeGroup

Parameters:

application - This parameter is required.

generateUniqueHash

@Stability(Experimental)
@NotNull
protected String generateUniqueHash(@NotNull
 String resourceAddress)

(experimental) Create a unique hash.

Parameters:

resourceAddress - This parameter is required.

getAttributeGroupSharePermissionARN

@Stability(Experimental)
@NotNull
protected String getAttributeGroupSharePermissionARN(@NotNull
 ShareOptions shareOptions)

(experimental) Get the correct permission ARN based on the SharePermission.

Parameters:

shareOptions - This parameter is required.

shareAttributeGroup

@Stability(Experimental)
public void shareAttributeGroup(@NotNull
 String id,
 @NotNull
 ShareOptions shareOptions)

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

Specified by:

shareAttributeGroup in interface IAttributeGroup

Parameters:

id - This parameter is required.

shareOptions - This parameter is required.

getAttributeGroupArn

@Stability(Experimental)
@NotNull
public String getAttributeGroupArn()

(experimental) The ARN of the attribute group.

Specified by:

getAttributeGroupArn in interface IAttributeGroup

getAttributeGroupId

@Stability(Experimental)
@NotNull
public String getAttributeGroupId()

(experimental) The ID of the attribute group.

Specified by:

getAttributeGroupId in interface IAttributeGroup