software.amazon.awscdk.services.appconfig

Class CfnHostedConfigurationVersion

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

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.307Z")
 @Stability(value=Stable)
public class CfnHostedConfigurationVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppConfig::HostedConfigurationVersion`.

Create a new configuration in the AWS AppConfig hosted configuration store. Configurations must be 1 MB or smaller. The AWS AppConfig hosted configuration store provides the following benefits over other configuration store options.

• You don't need to set up and configure other services such as Amazon Simple Storage Service ( Amazon S3 ) or Parameter Store.
• You don't need to configure AWS Identity and Access Management ( IAM ) permissions to use the configuration store.
• You can store configurations in any content type.
• There is no cost to use the store.
• You can create a configuration and add it to the store when you create a configuration profile.

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.*;
 CfnHostedConfigurationVersion cfnHostedConfigurationVersion = CfnHostedConfigurationVersion.Builder.create(this, "MyCfnHostedConfigurationVersion")
         .applicationId("applicationId")
         .configurationProfileId("configurationProfileId")
         .content("content")
         .contentType("contentType")
         // the properties below are optional
         .description("description")
         .latestVersionNumber(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnHostedConfigurationVersion.Builder A fluent builder for CfnHostedConfigurationVersion.

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

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The application ID.
protected Map<String,Object>	getCfnProperties()
String	getConfigurationProfileId() The configuration profile ID.
String	getContent() The content of the configuration or the configuration data.
String	getContentType() A standard MIME type describing the format of the configuration content.
String	getDescription() A description of the configuration.
Number	getLatestVersionNumber() An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.
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	setConfigurationProfileId(String value) The configuration profile ID.
void	setContent(String value) The content of the configuration or the configuration data.
void	setContentType(String value) A standard MIME type describing the format of the configuration content.
void	setDescription(String value) A description of the configuration.
void	setLatestVersionNumber(Number value) An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.

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

CfnHostedConfigurationVersion

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

CfnHostedConfigurationVersion

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

CfnHostedConfigurationVersion

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

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

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.

getConfigurationProfileId

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

The configuration profile ID.

setConfigurationProfileId

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

The configuration profile ID.

getContent

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

The content of the configuration or the configuration data.

setContent

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

The content of the configuration or the configuration data.

getContentType

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

A standard MIME type describing the format of the configuration content.

For more information, see Content-Type .

setContentType

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

A standard MIME type describing the format of the configuration content.

For more information, see Content-Type .

getDescription

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

A description of the configuration.

setDescription

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

A description of the configuration.

getLatestVersionNumber

@Stability(value=Stable)
 @Nullable
public Number getLatestVersionNumber()

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.

To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

setLatestVersionNumber

@Stability(value=Stable)
public void setLatestVersionNumber(@Nullable
                                                            Number value)

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.

To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.