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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-10-26T00:56:03.888Z") @Stability(Stable) public class CfnConfigurationProfile extends CfnResource implements IInspectable
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
  • Create a deployment strategy
  • 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(TagsProperty.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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the configuration profile.

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

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)

    • 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<CfnConfigurationProfile.TagsProperty> getTags()
      Metadata to assign to the configuration profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnConfigurationProfile.TagsProperty> 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.