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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.295Z")
 @Stability(value=Stable)
public class CfnConfigurationProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppConfig::ConfigurationProfile`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfigurationProfile.Builder A fluent builder for CfnConfigurationProfile.
static interface	CfnConfigurationProfile.TagsProperty Metadata to assign to the configuration profile.
static interface	CfnConfigurationProfile.ValidatorsProperty A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended.

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
	CfnConfigurationProfile(software.constructs.Construct scope, String id, CfnConfigurationProfileProps props) Create a new `AWS::AppConfig::ConfigurationProfile`.
protected	CfnConfigurationProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The application ID.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the configuration profile.
String	getLocationUri() A URI to locate the configuration.
String	getName() A name for the configuration profile.
String	getRetrievalRoleArn() The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .
List<CfnConfigurationProfile.TagsProperty>	getTags() Metadata to assign to the configuration profile.
String	getType() The type of configurations contained in the profile.
Object	getValidators() A list of methods for validating the configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The application ID.
void	setDescription(String value) A description of the configuration profile.
void	setLocationUri(String value) A URI to locate the configuration.
void	setName(String value) A name for the configuration profile.
void	setRetrievalRoleArn(String value) The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .
void	setTags(List<CfnConfigurationProfile.TagsProperty> value) Metadata to assign to the configuration profile.
void	setType(String value) The type of configurations contained in the profile.
void	setValidators(IResolvable value) A list of methods for validating the configuration.
void	setValidators(List<Object> value) A list of methods for validating the configuration.

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

CfnConfigurationProfile

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

CfnConfigurationProfile

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

CfnConfigurationProfile

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

Create a new `AWS::AppConfig::ConfigurationProfile`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getApplicationId

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

The application ID.

setApplicationId

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

The application ID.

getLocationUri

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

A URI to locate the configuration.

You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted . For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

setLocationUri

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

A URI to locate the configuration.

You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted . For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

getName

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

A name for the configuration profile.

setName

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

A name for the configuration profile.

getDescription

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

A description of the configuration profile.

setDescription

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

A description of the configuration profile.

getRetrievalRoleArn

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

The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .

A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.

setRetrievalRoleArn

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

The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .

A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.

getTags

@Stability(value=Stable)
 @Nullable
public List<CfnConfigurationProfile.TagsProperty> getTags()

Metadata to assign to the configuration profile.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

setTags

@Stability(value=Stable)
public void setTags(@Nullable
                                             List<CfnConfigurationProfile.TagsProperty> value)

Metadata to assign to the configuration profile.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

getType

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

The type of configurations contained in the profile.

AWS AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :

AWS.AppConfig.FeatureFlags

AWS.Freeform

setType

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

The type of configurations contained in the profile.

AWS AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :

AWS.AppConfig.FeatureFlags

AWS.Freeform

getValidators

@Stability(value=Stable)
 @Nullable
public Object getValidators()

A list of methods for validating the configuration.

setValidators

@Stability(value=Stable)
public void setValidators(@Nullable
                                                   IResolvable value)

A list of methods for validating the configuration.

setValidators

@Stability(value=Stable)
public void setValidators(@Nullable
                                                   List<Object> value)

A list of methods for validating the configuration.