class HostedConfiguration (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.HostedConfiguration |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#HostedConfiguration |
Java | software.amazon.awscdk.services.appconfig.HostedConfiguration |
Python | aws_cdk.aws_appconfig.HostedConfiguration |
TypeScript (source) | aws-cdk-lib » aws_appconfig » HostedConfiguration |
Implements
IConstruct
, IDependable
, IConfiguration
, IExtensible
A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.
Example
const app = new appconfig.Application(this, 'MyApp');
const env = new appconfig.Environment(this, 'MyEnv', {
application: app,
});
new appconfig.HostedConfiguration(this, 'MyHostedConfig', {
application: app,
deployTo: [env],
content: appconfig.ConfigurationContent.fromInlineText('This is my configuration content.'),
});
Initializer
new HostedConfiguration(scope: Construct, id: string, props: HostedConfigurationProps)
Parameters
- scope
Construct
- id
string
- props
Hosted
Configuration Props
Construct Props
Name | Type | Description |
---|---|---|
application | IApplication | The application associated with the configuration. |
content | Configuration | The content of the hosted configuration. |
deploy | IEnvironment [] | The list of environments to deploy the configuration to. |
deployment | IKey | The deployment key of the configuration. |
deployment | IDeployment | The deployment strategy for the configuration. |
description? | string | The description of the configuration. |
latest | number | The latest version number of the hosted configuration. |
name? | string | The name of the configuration. |
type? | Configuration | The type of configuration. |
validators? | IValidator [] | The validators for the configuration. |
version | string | The version label of the hosted configuration. |
application
Type:
IApplication
The application associated with the configuration.
content
Type:
Configuration
The content of the hosted configuration.
deployTo?
Type:
IEnvironment
[]
(optional, default: None.)
The list of environments to deploy the configuration to.
If this parameter is not specified, then there will be no deployment created alongside this configuration.
Deployments can be added later using the IEnvironment.addDeployment
or
IEnvironment.addDeployments
methods.
deploymentKey?
Type:
IKey
(optional, default: None.)
The deployment key of the configuration.
deploymentStrategy?
Type:
IDeployment
(optional, default: A deployment strategy with the rollout strategy set to
RolloutStrategy.CANARY_10_PERCENT_20_MINUTES)
The deployment strategy for the configuration.
description?
Type:
string
(optional, default: No description.)
The description of the configuration.
latestVersionNumber?
Type:
number
(optional, default: None.)
The latest version number of the hosted configuration.
name?
Type:
string
(optional, default: A name is generated.)
The name of the configuration.
type?
Type:
Configuration
(optional, default: ConfigurationType.FREEFORM)
The type of configuration.
validators?
Type:
IValidator
[]
(optional, default: No validators.)
The validators for the configuration.
versionLabel?
Type:
string
(optional, default: None.)
The version label of the hosted configuration.
Properties
Name | Type | Description |
---|---|---|
application | IApplication | The application associated with the configuration. |
application | string | |
configuration | string | The Amazon Resource Name (ARN) of the configuration profile. |
configuration | string | The ID of the configuration profile. |
content | string | The content of the hosted configuration. |
extensible | Extensible | |
hosted | string | The Amazon Resource Name (ARN) of the hosted configuration version. |
node | Node | The tree node. |
content | string | The content type of the hosted configuration. |
deploy | IEnvironment [] | The environments to deploy to. |
deployment | IKey | The deployment key for the configuration. |
deployment | IDeployment | The deployment strategy for the configuration. |
description? | string | The description of the configuration. |
latest | number | The latest version number of the hosted configuration. |
name? | string | The name of the configuration. |
type? | Configuration | The configuration type. |
validators? | IValidator [] | The validators for the configuration. |
version | string | The version label of the hosted configuration. |
version | string | The version number of the hosted configuration. |
application
Type:
IApplication
The application associated with the configuration.
applicationId
Type:
string
configurationProfileArn
Type:
string
The Amazon Resource Name (ARN) of the configuration profile.
configurationProfileId
Type:
string
The ID of the configuration profile.
content
Type:
string
The content of the hosted configuration.
extensible
Type:
Extensible
hostedConfigurationVersionArn
Type:
string
The Amazon Resource Name (ARN) of the hosted configuration version.
node
Type:
Node
The tree node.
contentType?
Type:
string
(optional)
The content type of the hosted configuration.
deployTo?
Type:
IEnvironment
[]
(optional)
The environments to deploy to.
deploymentKey?
Type:
IKey
(optional)
The deployment key for the configuration.
deploymentStrategy?
Type:
IDeployment
(optional)
The deployment strategy for the configuration.
description?
Type:
string
(optional)
The description of the configuration.
latestVersionNumber?
Type:
number
(optional)
The latest version number of the hosted configuration.
name?
Type:
string
(optional)
The name of the configuration.
type?
Type:
Configuration
(optional)
The configuration type.
validators?
Type:
IValidator
[]
(optional)
The validators for the configuration.
versionLabel?
Type:
string
(optional)
The version label of the hosted configuration.
versionNumber?
Type:
string
(optional)
The version number of the hosted configuration.
Methods
Name | Description |
---|---|
add | Adds an extension association to the configuration profile. |
on(actionPoint, eventDestination, options?) | Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile. |
pre | Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile. |
pre | Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile. |
to | Returns a string representation of this construct. |
protected add | |
protected deploy |
Extension(extension)
addpublic addExtension(extension: IExtension): void
Parameters
- extension
IExtension
— The extension to create an association for.
Adds an extension association to the configuration profile.
on(actionPoint, eventDestination, options?)
public on(actionPoint: ActionPoint, eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- actionPoint
Action
— The action point which triggers the event.Point - eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.
DeploymentBaking(eventDestination, options?)
onpublic onDeploymentBaking(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentComplete(eventDestination, options?)
onpublic onDeploymentComplete(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentRolledBack(eventDestination, options?)
onpublic onDeploymentRolledBack(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentStart(eventDestination, options?)
onpublic onDeploymentStart(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentStep(eventDestination, options?)
onpublic onDeploymentStep(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.
CreateHostedConfigurationVersion(eventDestination, options?)
prepublic preCreateHostedConfigurationVersion(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.
StartDeployment(eventDestination, options?)
prepublic preStartDeployment(eventDestination: IEventDestination, options?: ExtensionOptions): void
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
ExistingEnvironmentsToApplication()
protected addprotected addExistingEnvironmentsToApplication(): void
ConfigToEnvironments()
protected deployprotected deployConfigToEnvironments(): void