software.amazon.awscdk.services.servicecatalogappregistry

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.113Z")
 @Stability(value=Stable)
public class CfnAttributeGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalogAppRegistry::AttributeGroup`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAttributeGroup.Builder A fluent builder for CfnAttributeGroup.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAttributeGroup(software.constructs.Construct scope, String id, CfnAttributeGroupProps props) Create a new `AWS::ServiceCatalogAppRegistry::AttributeGroup`.
protected	CfnAttributeGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAttributeGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Arn for the attribute group.
Object	getAttributes() A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
String	getAttrId() The attribute group Id in the respective resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the attribute group that the user provides.
String	getName() The name of the attribute group.
TagManager	getTags() Key-value pairs you can use to associate with the attribute group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributes(Object value) A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
void	setDescription(String value) The description of the attribute group that the user provides.
void	setName(String value) The name of the attribute group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAttributeGroup

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

CfnAttributeGroup

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

CfnAttributeGroup

@Stability(value=Stable)
public CfnAttributeGroup(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnAttributeGroupProps props)

Create a new `AWS::ServiceCatalogAppRegistry::AttributeGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Arn for the attribute group.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The attribute group Id in the respective resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Key-value pairs you can use to associate with the attribute group.

getAttributes

@Stability(value=Stable)
 @NotNull
public Object getAttributes()

A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

setAttributes

@Stability(value=Stable)
public void setAttributes(@NotNull
                                                   Object value)

A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the attribute group.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the attribute group.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the attribute group that the user provides.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the attribute group that the user provides.