Package software.amazon.awscdk.services.appconfig

Class CfnConfigurationProfile

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.appconfig.CfnConfigurationProfile
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:02.276Z") @Stability(Stable) public class CfnConfigurationProfile extends CfnResource implements IInspectable, ITaggableV2
The AWS::AppConfig::ConfigurationProfile resource creates a configuration profile that enables AWS AppConfig to access the configuration source.

Valid configuration sources include AWS Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 . A configuration profile includes the following information.

  • The Uri location of the configuration data.
  • The AWS Identity and Access Management ( IAM ) role that provides access to the configuration data.
  • A validator for the configuration data. Available validators include either a JSON Schema or the Amazon Resource Name (ARN) of an AWS Lambda function.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

  • Create an application
  • Create an environment
  • Create a configuration profile
  • Choose a pre-defined deployment strategy or create your own
  • Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

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.appconfig.*;
 CfnConfigurationProfile cfnConfigurationProfile = CfnConfigurationProfile.Builder.create(this, "MyCfnConfigurationProfile")
         .applicationId("applicationId")
         .locationUri("locationUri")
         .name("name")
         // the properties below are optional
         .description("description")
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .retrievalRoleArn("retrievalRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .validators(List.of(ValidatorsProperty.builder()
                 .content("content")
                 .type("type")
                 .build()))
         .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

    • CfnConfigurationProfile

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

    • CfnConfigurationProfile

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

    • CfnConfigurationProfile

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

    • getAttrConfigurationProfileId

      @Stability(Stable) @NotNull public String getAttrConfigurationProfileId()
      The configuration profile ID.

    • getAttrKmsKeyArn

      @Stability(Stable) @NotNull public String getAttrKmsKeyArn()
      The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store.

      This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

    • 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

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The application ID.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The application ID.

    • getLocationUri

      @Stability(Stable) @NotNull public String getLocationUri()
      A URI to locate the configuration.

      You can specify the following:.

    • setLocationUri

      @Stability(Stable) public void setLocationUri(@NotNull String value)
      A URI to locate the configuration.

      You can specify the following:.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name for the configuration profile.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name for the configuration profile.

    • getDescription

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

    • setDescription

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

    • getKmsKeyIdentifier

      @Stability(Stable) @Nullable public String getKmsKeyIdentifier()
      The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)
      The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • getRetrievalRoleArn

      @Stability(Stable) @Nullable public String getRetrievalRoleArn()
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri .

    • setRetrievalRoleArn

      @Stability(Stable) public void setRetrievalRoleArn(@Nullable String value)
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri .

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata to assign to the configuration profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata to assign to the configuration profile.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The type of configurations contained in the profile.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The type of configurations contained in the profile.

    • getValidators

      @Stability(Stable) @Nullable public Object getValidators()
      A list of methods for validating the configuration.

    • setValidators

      @Stability(Stable) public void setValidators(@Nullable IResolvable value)
      A list of methods for validating the configuration.

    • setValidators

      @Stability(Stable) public void setValidators(@Nullable List<Object> value)
      A list of methods for validating the configuration.