Class CfnAttributeGroup
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.servicecatalogappregistry.CfnAttributeGroup
- All Implemented Interfaces:
IInspectable,ITaggable,IAttributeGroupRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-10-14T12:28:20.666Z")
@Stability(Stable)
public class CfnAttributeGroup
extends CfnResource
implements IInspectable, IAttributeGroupRef, ITaggable
Creates a new attribute group as a container for user-defined attributes.
This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.servicecatalogappregistry.*;
Object attributes;
CfnAttributeGroup cfnAttributeGroup = CfnAttributeGroup.Builder.create(this, "MyCfnAttributeGroup")
.attributes(attributes)
.name("name")
// the properties below are optional
.description("description")
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalogappregistry.IAttributeGroupRef
IAttributeGroupRef.Jsii$Default, IAttributeGroupRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnAttributeGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnAttributeGroup(software.amazon.jsii.JsiiObjectRef objRef) CfnAttributeGroup(software.constructs.Construct scope, String id, CfnAttributeGroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IAttributeGroupReffromAttributeGroupArn(software.constructs.Construct scope, String id, String arn) Creates a new IAttributeGroupRef from an ARN.static IAttributeGroupReffromAttributeGroupId(software.constructs.Construct scope, String id, String attributeGroupId) Creates a new IAttributeGroupRef from a attributeGroupId.The Amazon resource name (ARN) that specifies the attribute group across services.A reference to a AttributeGroup resource.A nested object in a JSON or YAML template that supports arbitrary definitions.The globally unique attribute group identifier of the attribute group.The description of the attribute group that the user provides.getName()The name of the attribute group.getTags()Tag Manager which manages the tags for this resource.Key-value pairs you can use to associate with the attribute group.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetAttributes(Object value) A nested object in a JSON or YAML template that supports arbitrary definitions.voidsetDescription(String value) The description of the attribute group that the user provides.voidThe name of the attribute group.voidsetTagsRaw(Map<String, String> value) Key-value pairs you can use to associate with the attribute group.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAttributeGroup
protected CfnAttributeGroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAttributeGroup
protected CfnAttributeGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAttributeGroup
@Stability(Stable) public CfnAttributeGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAttributeGroupProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
fromAttributeGroupArn
@Stability(Stable) @NotNull public static IAttributeGroupRef fromAttributeGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn) Creates a new IAttributeGroupRef from an ARN.- Parameters:
scope- This parameter is required.id- This parameter is required.arn- This parameter is required.
-
fromAttributeGroupId
@Stability(Stable) @NotNull public static IAttributeGroupRef fromAttributeGroupId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String attributeGroupId) Creates a new IAttributeGroupRef from a attributeGroupId.- Parameters:
scope- This parameter is required.id- This parameter is required.attributeGroupId- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon resource name (ARN) that specifies the attribute group across services. -
getAttributeGroupRef
A reference to a AttributeGroup resource.- Specified by:
getAttributeGroupRefin interfaceIAttributeGroupRef
-
getAttrId
The globally unique attribute group identifier of the attribute group. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAttributes
A nested object in a JSON or YAML template that supports arbitrary definitions. -
setAttributes
A nested object in a JSON or YAML template that supports arbitrary definitions. -
getName
The name of the attribute group. -
setName
The name of the attribute group. -
getDescription
The description of the attribute group that the user provides. -
setDescription
The description of the attribute group that the user provides. -
getTagsRaw
Key-value pairs you can use to associate with the attribute group. -
setTagsRaw
Key-value pairs you can use to associate with the attribute group.
-