Package software.amazon.awscdk.services.ssmquicksetup

Class CfnConfigurationManager

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.ssmquicksetup.CfnConfigurationManager
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:25:07.819Z") @Stability(Stable) public class CfnConfigurationManager extends CfnResource implements IInspectable, ITaggableV2
Creates a Quick Setup configuration manager resource.

This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.

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.ssmquicksetup.*;
 CfnConfigurationManager cfnConfigurationManager = CfnConfigurationManager.Builder.create(this, "MyCfnConfigurationManager")
         .configurationDefinitions(List.of(ConfigurationDefinitionProperty.builder()
                 .parameters(Map.of(
                         "parametersKey", "parameters"))
                 .type("type")
                 // the properties below are optional
                 .id("id")
                 .localDeploymentAdministrationRoleArn("localDeploymentAdministrationRoleArn")
                 .localDeploymentExecutionRoleName("localDeploymentExecutionRoleName")
                 .typeVersion("typeVersion")
                 .build()))
         // the properties below are optional
         .description("description")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • 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

    • CfnConfigurationManager

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

    • CfnConfigurationManager

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

    • CfnConfigurationManager

      @Stability(Stable) public CfnConfigurationManager(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfigurationManagerProps 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

    • 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The datetime stamp when the configuration manager was created.

    • getAttrLastModifiedAt

      @Stability(Stable) @NotNull public String getAttrLastModifiedAt()
      The datetime stamp when the configuration manager was last updated.

    • getAttrManagerArn

      @Stability(Stable) @NotNull public String getAttrManagerArn()
      The ARN of the Quick Setup configuration.

    • getAttrStatusSummaries

      @Stability(Stable) @NotNull public IResolvable getAttrStatusSummaries()
      Summaries of the state of the configuration manager.

      These summaries include an aggregate of the statuses from the configuration definition associated with the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getConfigurationDefinitions

      @Stability(Stable) @NotNull public Object getConfigurationDefinitions()
      The definition of the Quick Setup configuration that the configuration manager deploys.

    • setConfigurationDefinitions

      @Stability(Stable) public void setConfigurationDefinitions(@NotNull IResolvable value)
      The definition of the Quick Setup configuration that the configuration manager deploys.

    • setConfigurationDefinitions

      @Stability(Stable) public void setConfigurationDefinitions(@NotNull List<Object> value)
      The definition of the Quick Setup configuration that the configuration manager deploys.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the configuration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the configuration.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the configuration.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the configuration.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Key-value pairs of metadata to assign to the configuration manager.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Key-value pairs of metadata to assign to the configuration manager.