interface HostedConfigurationOptions
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.HostedConfigurationOptions |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#HostedConfigurationOptions |
Java | software.amazon.awscdk.services.appconfig.alpha.HostedConfigurationOptions |
Python | aws_cdk.aws_appconfig_alpha.HostedConfigurationOptions |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » HostedConfigurationOptions |
⚠️ Deprecated: undefined
Options for HostedConfiguration.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
import { aws_kms as kms } from 'aws-cdk-lib';
declare const configurationContent: appconfig_alpha.ConfigurationContent;
declare const deploymentStrategy: appconfig_alpha.DeploymentStrategy;
declare const environment: appconfig_alpha.Environment;
declare const key: kms.Key;
declare const validator: appconfig_alpha.IValidator;
const hostedConfigurationOptions: appconfig_alpha.HostedConfigurationOptions = {
content: configurationContent,
// the properties below are optional
deploymentKey: key,
deploymentStrategy: deploymentStrategy,
deployTo: [environment],
description: 'description',
latestVersionNumber: 123,
name: 'name',
type: appconfig_alpha.ConfigurationType.FREEFORM,
validators: [validator],
versionLabel: 'versionLabel',
};
Properties
Name | Type | Description |
---|---|---|
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. |
content
⚠️ Deprecated: undefined
Type:
Configuration
The content of the hosted configuration.
deployTo?
⚠️ Deprecated: undefined
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.
deploymentKey?
⚠️ Deprecated: undefined
Type:
IKey
(optional, default: None.)
The deployment key of the configuration.
deploymentStrategy?
⚠️ Deprecated: undefined
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?
⚠️ Deprecated: undefined
Type:
string
(optional, default: No description.)
The description of the configuration.
latestVersionNumber?
⚠️ Deprecated: undefined
Type:
number
(optional, default: None.)
The latest version number of the hosted configuration.
name?
⚠️ Deprecated: undefined
Type:
string
(optional, default: A name is generated.)
The name of the configuration.
type?
⚠️ Deprecated: undefined
Type:
Configuration
(optional, default: ConfigurationType.FREEFORM)
The type of configuration.
validators?
⚠️ Deprecated: undefined
Type:
IValidator
[]
(optional, default: No validators.)
The validators for the configuration.
versionLabel?
⚠️ Deprecated: undefined
Type:
string
(optional, default: None.)
The version label of the hosted configuration.