awsappconfig

package
v2.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnApplication_CFN_RESOURCE_TYPE_NAME 

func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplication_IsCfnElement 

func CfnApplication_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApplication_IsCfnResource 

func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApplication_IsConstruct 

func CfnApplication_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnConfigurationProfile_CFN_RESOURCE_TYPE_NAME 

func CfnConfigurationProfile_CFN_RESOURCE_TYPE_NAME() *string

func CfnConfigurationProfile_IsCfnElement 

func CfnConfigurationProfile_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnConfigurationProfile_IsCfnResource 

func CfnConfigurationProfile_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnConfigurationProfile_IsConstruct 

func CfnConfigurationProfile_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDeploymentStrategy_CFN_RESOURCE_TYPE_NAME 

func CfnDeploymentStrategy_CFN_RESOURCE_TYPE_NAME() *string

func CfnDeploymentStrategy_IsCfnElement 

func CfnDeploymentStrategy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDeploymentStrategy_IsCfnResource 

func CfnDeploymentStrategy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDeploymentStrategy_IsConstruct 

func CfnDeploymentStrategy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDeployment_CFN_RESOURCE_TYPE_NAME 

func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string

func CfnDeployment_IsCfnElement 

func CfnDeployment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDeployment_IsCfnResource 

func CfnDeployment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDeployment_IsConstruct 

func CfnDeployment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME 

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string

func CfnEnvironment_IsCfnElement 

func CfnEnvironment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEnvironment_IsCfnResource 

func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEnvironment_IsConstruct 

func CfnEnvironment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnHostedConfigurationVersion_CFN_RESOURCE_TYPE_NAME 

func CfnHostedConfigurationVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnHostedConfigurationVersion_IsCfnElement 

func CfnHostedConfigurationVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnHostedConfigurationVersion_IsCfnResource 

func CfnHostedConfigurationVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnHostedConfigurationVersion_IsConstruct 

func CfnHostedConfigurationVersion_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnApplication_Override 

func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, props *CfnApplicationProps)

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

func NewCfnConfigurationProfile_Override 

func NewCfnConfigurationProfile_Override(c CfnConfigurationProfile, scope constructs.Construct, id *string, props *CfnConfigurationProfileProps)

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

func NewCfnDeploymentStrategy_Override 

func NewCfnDeploymentStrategy_Override(c CfnDeploymentStrategy, scope constructs.Construct, id *string, props *CfnDeploymentStrategyProps)

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

func NewCfnDeployment_Override 

func NewCfnDeployment_Override(c CfnDeployment, scope constructs.Construct, id *string, props *CfnDeploymentProps)

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

func NewCfnEnvironment_Override 

func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)

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

func NewCfnHostedConfigurationVersion_Override 

func NewCfnHostedConfigurationVersion_Override(c CfnHostedConfigurationVersion, scope constructs.Construct, id *string, props *CfnHostedConfigurationVersionProps)

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

Types

type CfnApplication 

type CfnApplication interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() *[]*CfnApplication_TagsProperty
	SetTags(val *[]*CfnApplication_TagsProperty)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppConfig::Application`.

The `AWS::AppConfig::Application` resource creates an application. In AWS AppConfig , an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

TODO: EXAMPLE

func NewCfnApplication 

func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication

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

type CfnApplicationProps 

type CfnApplicationProps struct {
	// A name for the application.
	Name *string `json:"name" yaml:"name"`
	// A description of the application.
	Description *string `json:"description" yaml:"description"`
	// Metadata to assign to the application.
	//
	// Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
	Tags *[]*CfnApplication_TagsProperty `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnApplication`.

TODO: EXAMPLE

type CfnApplication_TagsProperty 

type CfnApplication_TagsProperty struct {
	// The key-value string map.
	//
	// The valid character set is `[a-zA-Z+-=._:/]` . The tag key can be up to 128 characters and must not start with `aws:` .
	Key *string `json:"key" yaml:"key"`
	// The tag value can be up to 256 characters.
	Value *string `json:"value" yaml:"value"`
}

Metadata to assign to the application.

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

TODO: EXAMPLE

type CfnConfigurationProfile 

type CfnConfigurationProfile interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LocationUri() *string
	SetLocationUri(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RetrievalRoleArn() *string
	SetRetrievalRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() *[]*CfnConfigurationProfile_TagsProperty
	SetTags(val *[]*CfnConfigurationProfile_TagsProperty)
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	Validators() interface{}
	SetValidators(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

TODO: EXAMPLE

func NewCfnConfigurationProfile 

func NewCfnConfigurationProfile(scope constructs.Construct, id *string, props *CfnConfigurationProfileProps) CfnConfigurationProfile

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

type CfnConfigurationProfileProps 

type CfnConfigurationProfileProps struct {
	// The application ID.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// 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`
	LocationUri *string `json:"locationUri" yaml:"locationUri"`
	// A name for the configuration profile.
	Name *string `json:"name" yaml:"name"`
	// A description of the configuration profile.
	Description *string `json:"description" yaml:"description"`
	// 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.
	RetrievalRoleArn *string `json:"retrievalRoleArn" yaml:"retrievalRoleArn"`
	// 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.
	Tags *[]*CfnConfigurationProfile_TagsProperty `json:"tags" yaml:"tags"`
	// 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`
	Type *string `json:"type" yaml:"type"`
	// A list of methods for validating the configuration.
	Validators interface{} `json:"validators" yaml:"validators"`
}

Properties for defining a `CfnConfigurationProfile`.

TODO: EXAMPLE

type CfnConfigurationProfile_TagsProperty 

type CfnConfigurationProfile_TagsProperty struct {
	// The key-value string map.
	//
	// The valid character set is `[a-zA-Z+-=._:/]` . The tag key can be up to 128 characters and must not start with `aws:` .
	Key *string `json:"key" yaml:"key"`
	// The tag value can be up to 256 characters.
	Value *string `json:"value" yaml:"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.

TODO: EXAMPLE

type CfnConfigurationProfile_ValidatorsProperty 

type CfnConfigurationProfile_ValidatorsProperty struct {
	// Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
	Content *string `json:"content" yaml:"content"`
	// AWS AppConfig supports validators of type `JSON_SCHEMA` and `LAMBDA`.
	Type *string `json:"type" yaml:"type"`
}

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended.

To validate your application configuration data, you provide a schema or an AWS Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

TODO: EXAMPLE

type CfnDeployment 

type CfnDeployment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationProfileId() *string
	SetConfigurationProfileId(val *string)
	ConfigurationVersion() *string
	SetConfigurationVersion(val *string)
	CreationStack() *[]*string
	DeploymentStrategyId() *string
	SetDeploymentStrategyId(val *string)
	Description() *string
	SetDescription(val *string)
	EnvironmentId() *string
	SetEnvironmentId(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() *[]*CfnDeployment_TagsProperty
	SetTags(val *[]*CfnDeployment_TagsProperty)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppConfig::Deployment`.

The `AWS::AppConfig::Deployment` resource starts a deployment. Starting a deployment in AWS AppConfig calls the `StartDeployment` API action. This call includes the IDs of the AWS AppConfig application, the environment, the configuration profile, and (optionally) the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed.

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

TODO: EXAMPLE

func NewCfnDeployment 

func NewCfnDeployment(scope constructs.Construct, id *string, props *CfnDeploymentProps) CfnDeployment

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

type CfnDeploymentProps 

type CfnDeploymentProps struct {
	// The application ID.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The configuration profile ID.
	ConfigurationProfileId *string `json:"configurationProfileId" yaml:"configurationProfileId"`
	// The configuration version to deploy.
	ConfigurationVersion *string `json:"configurationVersion" yaml:"configurationVersion"`
	// The deployment strategy ID.
	DeploymentStrategyId *string `json:"deploymentStrategyId" yaml:"deploymentStrategyId"`
	// The environment ID.
	EnvironmentId *string `json:"environmentId" yaml:"environmentId"`
	// A description of the deployment.
	Description *string `json:"description" yaml:"description"`
	// Metadata to assign to the deployment.
	//
	// Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
	Tags *[]*CfnDeployment_TagsProperty `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDeployment`.

TODO: EXAMPLE

type CfnDeploymentStrategy 

type CfnDeploymentStrategy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeploymentDurationInMinutes() *float64
	SetDeploymentDurationInMinutes(val *float64)
	Description() *string
	SetDescription(val *string)
	FinalBakeTimeInMinutes() *float64
	SetFinalBakeTimeInMinutes(val *float64)
	GrowthFactor() *float64
	SetGrowthFactor(val *float64)
	GrowthType() *string
	SetGrowthType(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	ReplicateTo() *string
	SetReplicateTo(val *string)
	Stack() awscdk.Stack
	Tags() *[]*CfnDeploymentStrategy_TagsProperty
	SetTags(val *[]*CfnDeploymentStrategy_TagsProperty)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppConfig::DeploymentStrategy`.

The `AWS::AppConfig::DeploymentStrategy` resource creates an AWS AppConfig deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

TODO: EXAMPLE

func NewCfnDeploymentStrategy 

func NewCfnDeploymentStrategy(scope constructs.Construct, id *string, props *CfnDeploymentStrategyProps) CfnDeploymentStrategy

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

type CfnDeploymentStrategyProps 

type CfnDeploymentStrategyProps struct {
	// Total amount of time for a deployment to last.
	DeploymentDurationInMinutes *float64 `json:"deploymentDurationInMinutes" yaml:"deploymentDurationInMinutes"`
	// The percentage of targets to receive a deployed configuration during each interval.
	GrowthFactor *float64 `json:"growthFactor" yaml:"growthFactor"`
	// A name for the deployment strategy.
	Name *string `json:"name" yaml:"name"`
	// Save the deployment strategy to a Systems Manager (SSM) document.
	ReplicateTo *string `json:"replicateTo" yaml:"replicateTo"`
	// A description of the deployment strategy.
	Description *string `json:"description" yaml:"description"`
	// The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
	FinalBakeTimeInMinutes *float64 `json:"finalBakeTimeInMinutes" yaml:"finalBakeTimeInMinutes"`
	// The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:.
	//
	// *Linear* : For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for `Step percentage` . For example, a linear deployment that uses a `Step percentage` of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.
	//
	// *Exponential* : For this type, AWS AppConfig processes the deployment exponentially using the following formula: `G*(2^N)` . In this formula, `G` is the growth factor specified by the user and `N` is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:
	//
	// `2*(2^0)`
	//
	// `2*(2^1)`
	//
	// `2*(2^2)`
	//
	// Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
	GrowthType *string `json:"growthType" yaml:"growthType"`
	// Assigns metadata to an AWS AppConfig resource.
	//
	// Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
	Tags *[]*CfnDeploymentStrategy_TagsProperty `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDeploymentStrategy`.

TODO: EXAMPLE

type CfnDeploymentStrategy_TagsProperty 

type CfnDeploymentStrategy_TagsProperty struct {
	// The key-value string map.
	//
	// The valid character set is `[a-zA-Z+-=._:/]` . The tag key can be up to 128 characters and must not start with `aws:` .
	Key *string `json:"key" yaml:"key"`
	// The tag value can be up to 256 characters.
	Value *string `json:"value" yaml:"value"`
}

Metadata to assign to the deployment strategy.

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

TODO: EXAMPLE

type CfnDeployment_TagsProperty 

type CfnDeployment_TagsProperty struct {
	// The key-value string map.
	//
	// The valid character set is `[a-zA-Z+-=._:/]` . The tag key can be up to 128 characters and must not start with `aws:` .
	Key *string `json:"key" yaml:"key"`
	// The tag value can be up to 256 characters.
	Value *string `json:"value" yaml:"value"`
}

Metadata to assign to the deployment strategy.

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

TODO: EXAMPLE

type CfnEnvironment 

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Monitors() interface{}
	SetMonitors(val interface{})
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() *[]*CfnEnvironment_TagsProperty
	SetTags(val *[]*CfnEnvironment_TagsProperty)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppConfig::Environment`.

The `AWS::AppConfig::Environment` resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a `Beta` or `Production` environment. You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the `Web` , `Mobile` and `Back-end` components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

TODO: EXAMPLE

func NewCfnEnvironment 

func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment

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

type CfnEnvironmentProps 

type CfnEnvironmentProps struct {
	// The application ID.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// A name for the environment.
	Name *string `json:"name" yaml:"name"`
	// A description of the environment.
	Description *string `json:"description" yaml:"description"`
	// Amazon CloudWatch alarms to monitor during the deployment process.
	Monitors interface{} `json:"monitors" yaml:"monitors"`
	// Metadata to assign to the environment.
	//
	// Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
	Tags *[]*CfnEnvironment_TagsProperty `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEnvironment`.

TODO: EXAMPLE

type CfnEnvironment_MonitorsProperty 

type CfnEnvironment_MonitorsProperty struct {
	// Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
	AlarmArn *string `json:"alarmArn" yaml:"alarmArn"`
	// ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor `AlarmArn` .
	AlarmRoleArn *string `json:"alarmRoleArn" yaml:"alarmRoleArn"`
}

Amazon CloudWatch alarms to monitor during the deployment process.

TODO: EXAMPLE

type CfnEnvironment_TagsProperty 

type CfnEnvironment_TagsProperty struct {
	// The key-value string map.
	//
	// The valid character set is `[a-zA-Z+-=._:/]` . The tag key can be up to 128 characters and must not start with `aws:` .
	Key *string `json:"key" yaml:"key"`
	// The tag value can be up to 256 characters.
	Value *string `json:"value" yaml:"value"`
}

Metadata to assign to the environment.

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

TODO: EXAMPLE

type CfnHostedConfigurationVersion 

type CfnHostedConfigurationVersion interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationProfileId() *string
	SetConfigurationProfileId(val *string)
	Content() *string
	SetContent(val *string)
	ContentType() *string
	SetContentType(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LatestVersionNumber() *float64
	SetLatestVersionNumber(val *float64)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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.

TODO: EXAMPLE

func NewCfnHostedConfigurationVersion 

func NewCfnHostedConfigurationVersion(scope constructs.Construct, id *string, props *CfnHostedConfigurationVersionProps) CfnHostedConfigurationVersion

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

type CfnHostedConfigurationVersionProps 

type CfnHostedConfigurationVersionProps struct {
	// The application ID.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The configuration profile ID.
	ConfigurationProfileId *string `json:"configurationProfileId" yaml:"configurationProfileId"`
	// The content of the configuration or the configuration data.
	Content *string `json:"content" yaml:"content"`
	// A standard MIME type describing the format of the configuration content.
	//
	// For more information, see [Content-Type](https://docs.aws.amazon.com/https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) .
	ContentType *string `json:"contentType" yaml:"contentType"`
	// A description of the configuration.
	Description *string `json:"description" yaml:"description"`
	// 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.
	LatestVersionNumber *float64 `json:"latestVersionNumber" yaml:"latestVersionNumber"`
}

Properties for defining a `CfnHostedConfigurationVersion`.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.