Package software.amazon.awscdk.services.servicecatalogappregistry

Class CfnAttributeGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.servicecatalogappregistry.CfnAttributeGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.764Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon resource name (ARN) that specifies the attribute group across services.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The globally unique attribute group identifier of the attribute group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs you can use to associate with the attribute group.

    • getAttributes

      @Stability(Stable) @NotNull public Object getAttributes()
      A nested object in a JSON or YAML template that supports arbitrary definitions.

      Represents the attributes in an attribute group that describes an application and its components.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull Object value)
      A nested object in a JSON or YAML template that supports arbitrary definitions.

      Represents the attributes in an attribute group that describes an application and its components.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the attribute group.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the attribute group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the attribute group that the user provides.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the attribute group that the user provides.