awselasticbeanstalk

package
v1.146.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Feb 25, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnApplicationVersion_CFN_RESOURCE_TYPE_NAME 

func CfnApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplicationVersion_IsCfnElement 

func CfnApplicationVersion_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. Experimental.

func CfnApplicationVersion_IsCfnResource 

func CfnApplicationVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApplicationVersion_IsConstruct 

func CfnApplicationVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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

func CfnApplication_IsCfnResource 

func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApplication_IsConstruct 

func CfnApplication_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnConfigurationTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnConfigurationTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnConfigurationTemplate_IsCfnElement 

func CfnConfigurationTemplate_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. Experimental.

func CfnConfigurationTemplate_IsCfnResource 

func CfnConfigurationTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnConfigurationTemplate_IsConstruct 

func CfnConfigurationTemplate_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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

func CfnEnvironment_IsCfnResource 

func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnEnvironment_IsConstruct 

func CfnEnvironment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnApplicationVersion_Override 

func NewCfnApplicationVersion_Override(c CfnApplicationVersion, scope awscdk.Construct, id *string, props *CfnApplicationVersionProps)

Create a new `AWS::ElasticBeanstalk::ApplicationVersion`.

func NewCfnApplication_Override 

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

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

func NewCfnConfigurationTemplate_Override 

func NewCfnConfigurationTemplate_Override(c CfnConfigurationTemplate, scope awscdk.Construct, id *string, props *CfnConfigurationTemplateProps)

Create a new `AWS::ElasticBeanstalk::ConfigurationTemplate`.

func NewCfnEnvironment_Override 

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

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

Types

type CfnApplication 

type CfnApplication interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationName() *string
	SetApplicationName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	ResourceLifecycleConfig() interface{}
	SetResourceLifecycleConfig(val interface{})
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ElasticBeanstalk::Application`.

Specify an AWS Elastic Beanstalk application by using the AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::Application resource is an AWS Elastic Beanstalk Beanstalk resource type that specifies an Elastic Beanstalk application.

TODO: EXAMPLE

func NewCfnApplication 

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

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

type CfnApplicationProps 

type CfnApplicationProps struct {
	// A name for the Elastic Beanstalk application.
	//
	// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
	//
	// > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// Your description of the application.
	Description *string `json:"description" yaml:"description"`
	// Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
	ResourceLifecycleConfig interface{} `json:"resourceLifecycleConfig" yaml:"resourceLifecycleConfig"`
}

Properties for defining a `CfnApplication`.

TODO: EXAMPLE

type CfnApplicationVersion 

type CfnApplicationVersion interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationName() *string
	SetApplicationName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	SourceBundle() interface{}
	SetSourceBundle(val interface{})
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ElasticBeanstalk::ApplicationVersion`.

Specify an AWS Elastic Beanstalk application version by using the AWS::ElasticBeanstalk::ApplicationVersion resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk resource type that specifies an application version, an iteration of deployable code, for an Elastic Beanstalk application.

> After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, an attempt to launch an environment from the application version will fail.

TODO: EXAMPLE

func NewCfnApplicationVersion 

func NewCfnApplicationVersion(scope awscdk.Construct, id *string, props *CfnApplicationVersionProps) CfnApplicationVersion

Create a new `AWS::ElasticBeanstalk::ApplicationVersion`.

type CfnApplicationVersionProps 

type CfnApplicationVersionProps struct {
	// The name of the Elastic Beanstalk application that is associated with this application version.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// The Amazon S3 bucket and key that identify the location of the source bundle for this version.
	//
	// > The Amazon S3 bucket must be in the same region as the environment.
	SourceBundle interface{} `json:"sourceBundle" yaml:"sourceBundle"`
	// A description of this application version.
	Description *string `json:"description" yaml:"description"`
}

Properties for defining a `CfnApplicationVersion`.

TODO: EXAMPLE

type CfnApplicationVersion_SourceBundleProperty 

type CfnApplicationVersion_SourceBundleProperty struct {
	// The Amazon S3 bucket where the data is located.
	S3Bucket *string `json:"s3Bucket" yaml:"s3Bucket"`
	// The Amazon S3 key where the data is located.
	S3Key *string `json:"s3Key" yaml:"s3Key"`
}

Use the `SourceBundle` property type to specify the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version when defining an AWS::ElasticBeanstalk::ApplicationVersion resource in an AWS CloudFormation template.

The `SourceBundle` property is an embedded property of the [AWS::ElasticBeanstalk::ApplicationVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html) resource. It specifies the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version.

TODO: EXAMPLE

type CfnApplication_ApplicationResourceLifecycleConfigProperty 

type CfnApplication_ApplicationResourceLifecycleConfigProperty struct {
	// The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
	//
	// The `ServiceRole` property is required the first time that you provide a `ResourceLifecycleConfig` for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.
	ServiceRole *string `json:"serviceRole" yaml:"serviceRole"`
	// Defines lifecycle settings for application versions.
	VersionLifecycleConfig interface{} `json:"versionLifecycleConfig" yaml:"versionLifecycleConfig"`
}

Use the `ApplicationResourceLifecycleConfig` property type to specify lifecycle settings for resources that belong to an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

`ApplicationResourceLifecycleConfig` is a property of the [AWS::ElasticBeanstalk::Application](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html) resource.

TODO: EXAMPLE

type CfnApplication_ApplicationVersionLifecycleConfigProperty 

type CfnApplication_ApplicationVersionLifecycleConfigProperty struct {
	// Specify a max age rule to restrict the length of time that application versions are retained for an application.
	MaxAgeRule interface{} `json:"maxAgeRule" yaml:"maxAgeRule"`
	// Specify a max count rule to restrict the number of application versions that are retained for an application.
	MaxCountRule interface{} `json:"maxCountRule" yaml:"maxCountRule"`
}

Use the `ApplicationVersionLifecycleConfig` property type to specify application version lifecycle settings for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

`ApplicationVersionLifecycleConfig` is a property of the [ApplicationResourceLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html) property type.

TODO: EXAMPLE

type CfnApplication_MaxAgeRuleProperty 

type CfnApplication_MaxAgeRuleProperty struct {
	// Set to `true` to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
	DeleteSourceFromS3 interface{} `json:"deleteSourceFromS3" yaml:"deleteSourceFromS3"`
	// Specify `true` to apply the rule, or `false` to disable it.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// Specify the number of days to retain an application versions.
	MaxAgeInDays *float64 `json:"maxAgeInDays" yaml:"maxAgeInDays"`
}

Use the `MaxAgeRule` property type to specify a max age rule to restrict the length of time that application versions are retained for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

A lifecycle rule that deletes application versions after the specified number of days.

`MaxAgeRule` is a property of the [ApplicationVersionLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html) property type.

TODO: EXAMPLE

type CfnApplication_MaxCountRuleProperty 

type CfnApplication_MaxCountRuleProperty struct {
	// Set to `true` to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
	DeleteSourceFromS3 interface{} `json:"deleteSourceFromS3" yaml:"deleteSourceFromS3"`
	// Specify `true` to apply the rule, or `false` to disable it.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// Specify the maximum number of application versions to retain.
	MaxCount *float64 `json:"maxCount" yaml:"maxCount"`
}

Use the `MaxAgeRule` property type to specify a max count rule to restrict the number of application versions that are retained for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

`MaxCountRule` is a property of the [ApplicationVersionLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html) property type.

TODO: EXAMPLE

type CfnConfigurationTemplate 

type CfnConfigurationTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationName() *string
	SetApplicationName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EnvironmentId() *string
	SetEnvironmentId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	OptionSettings() interface{}
	SetOptionSettings(val interface{})
	PlatformArn() *string
	SetPlatformArn(val *string)
	Ref() *string
	SolutionStackName() *string
	SetSolutionStackName(val *string)
	SourceConfiguration() interface{}
	SetSourceConfiguration(val interface{})
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ElasticBeanstalk::ConfigurationTemplate`.

Specify an AWS Elastic Beanstalk configuration template by using the AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

> The Elastic Beanstalk console and documentation often refer to configuration templates as *saved configurations* . When you set configuration options in a saved configuration (configuration template), Elastic Beanstalk applies them with a particular precedence as part of applying options from multiple sources. For more information, see [Configuration Options](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer Guide* .

TODO: EXAMPLE

func NewCfnConfigurationTemplate 

func NewCfnConfigurationTemplate(scope awscdk.Construct, id *string, props *CfnConfigurationTemplateProps) CfnConfigurationTemplate

Create a new `AWS::ElasticBeanstalk::ConfigurationTemplate`.

type CfnConfigurationTemplateProps 

type CfnConfigurationTemplateProps struct {
	// The name of the Elastic Beanstalk application to associate with this configuration template.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// An optional description for this configuration.
	Description *string `json:"description" yaml:"description"`
	// The ID of an environment whose settings you want to use to create the configuration template.
	//
	// You must specify `EnvironmentId` if you don't specify `PlatformArn` , `SolutionStackName` , or `SourceConfiguration` .
	EnvironmentId *string `json:"environmentId" yaml:"environmentId"`
	// Option values for the Elastic Beanstalk configuration, such as the instance type.
	//
	// If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer Guide* .
	OptionSettings interface{} `json:"optionSettings" yaml:"optionSettings"`
	// The Amazon Resource Name (ARN) of the custom platform.
	//
	// For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the *AWS Elastic Beanstalk Developer Guide* .
	//
	// > If you specify `PlatformArn` , then don't specify `SolutionStackName` .
	PlatformArn *string `json:"platformArn" yaml:"platformArn"`
	// The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
	//
	// For example, `64bit Amazon Linux 2013.09 running Tomcat 7 Java 7` . A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the *AWS Elastic Beanstalk Developer Guide* .
	//
	// You must specify `SolutionStackName` if you don't specify `PlatformArn` , `EnvironmentId` , or `SourceConfiguration` .
	//
	// Use the [`ListAvailableSolutionStacks`](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html) API to obtain a list of available solution stacks.
	SolutionStackName *string `json:"solutionStackName" yaml:"solutionStackName"`
	// An Elastic Beanstalk configuration template to base this one on.
	//
	// If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
	//
	// Values specified in `OptionSettings` override any values obtained from the `SourceConfiguration` .
	//
	// You must specify `SourceConfiguration` if you don't specify `PlatformArn` , `EnvironmentId` , or `SolutionStackName` .
	//
	// Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
	SourceConfiguration interface{} `json:"sourceConfiguration" yaml:"sourceConfiguration"`
}

Properties for defining a `CfnConfigurationTemplate`.

TODO: EXAMPLE

type CfnConfigurationTemplate_ConfigurationOptionSettingProperty 

type CfnConfigurationTemplate_ConfigurationOptionSettingProperty struct {
	// A unique namespace that identifies the option's associated AWS resource.
	Namespace *string `json:"namespace" yaml:"namespace"`
	// The name of the configuration option.
	OptionName *string `json:"optionName" yaml:"optionName"`
	// A unique resource name for the option setting.
	//
	// Use it for a time–based scaling configuration option.
	ResourceName *string `json:"resourceName" yaml:"resourceName"`
	// The current value for the configuration option.
	Value *string `json:"value" yaml:"value"`
}

Use the `ConfigurationOptionSetting` property type to specify an option for an AWS Elastic Beanstalk configuration template when defining an AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The `ConfigurationOptionSetting` property type specifies an option for an AWS Elastic Beanstalk configuration template.

The `OptionSettings` property of the [AWS::ElasticBeanstalk::ConfigurationTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html) resource contains a list of `ConfigurationOptionSetting` property types.

For a list of possible namespaces and option values, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer Guide* .

TODO: EXAMPLE

type CfnConfigurationTemplate_SourceConfigurationProperty 

type CfnConfigurationTemplate_SourceConfigurationProperty struct {
	// The name of the application associated with the configuration.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// The name of the configuration template.
	TemplateName *string `json:"templateName" yaml:"templateName"`
}

Use the `SourceConfiguration` property type to specify another AWS Elastic Beanstalk configuration template as the base to creating a new AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

An AWS Elastic Beanstalk configuration template to base a new one on. You can use it to define a [AWS::ElasticBeanstalk::ConfigurationTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html) resource.

TODO: EXAMPLE

type CfnEnvironment 

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationName() *string
	SetApplicationName(val *string)
	AttrEndpointUrl() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CnamePrefix() *string
	SetCnamePrefix(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EnvironmentName() *string
	SetEnvironmentName(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	OperationsRole() *string
	SetOperationsRole(val *string)
	OptionSettings() interface{}
	SetOptionSettings(val interface{})
	PlatformArn() *string
	SetPlatformArn(val *string)
	Ref() *string
	SolutionStackName() *string
	SetSolutionStackName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateName() *string
	SetTemplateName(val *string)
	Tier() interface{}
	SetTier(val interface{})
	UpdatedProperites() *map[string]interface{}
	VersionLabel() *string
	SetVersionLabel(val *string)
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ElasticBeanstalk::Environment`.

Specify an AWS Elastic Beanstalk environment by using the AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment.

TODO: EXAMPLE

func NewCfnEnvironment 

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

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

type CfnEnvironmentProps 

type CfnEnvironmentProps struct {
	// The name of the application that is associated with this environment.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
	//
	// If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
	CnamePrefix *string `json:"cnamePrefix" yaml:"cnamePrefix"`
	// Your description for this environment.
	Description *string `json:"description" yaml:"description"`
	// A unique name for the environment.
	//
	// Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account.
	//
	// If you don't specify the `CNAMEPrefix` parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
	//
	// If you don't specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
	//
	// > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	EnvironmentName *string `json:"environmentName" yaml:"environmentName"`
	// > The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
	//
	// The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the `iam:PassRole` permission for the role.
	OperationsRole *string `json:"operationsRole" yaml:"operationsRole"`
	// Key-value pairs defining configuration options for this environment, such as the instance type.
	//
	// These options override the values that are defined in the solution stack or the [configuration template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html) . If you remove any options during a stack update, the removed options retain their current values.
	OptionSettings interface{} `json:"optionSettings" yaml:"optionSettings"`
	// The Amazon Resource Name (ARN) of the custom platform to use with the environment.
	//
	// For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the *AWS Elastic Beanstalk Developer Guide* .
	//
	// > If you specify `PlatformArn` , don't specify `SolutionStackName` .
	PlatformArn *string `json:"platformArn" yaml:"platformArn"`
	// The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
	//
	// If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see [Elastic Beanstalk Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) in the *AWS Elastic Beanstalk Platforms* guide.
	//
	// > If you specify `SolutionStackName` , don't specify `PlatformArn` or `TemplateName` .
	SolutionStackName *string `json:"solutionStackName" yaml:"solutionStackName"`
	// Specifies the tags applied to resources in the environment.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The name of the Elastic Beanstalk configuration template to use with the environment.
	//
	// > If you specify `TemplateName` , then don't specify `SolutionStackName` .
	TemplateName *string `json:"templateName" yaml:"templateName"`
	// Specifies the tier to use in creating this environment.
	//
	// The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
	Tier interface{} `json:"tier" yaml:"tier"`
	// The name of the application version to deploy.
	//
	// Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
	VersionLabel *string `json:"versionLabel" yaml:"versionLabel"`
}

Properties for defining a `CfnEnvironment`.

TODO: EXAMPLE

type CfnEnvironment_OptionSettingProperty 

type CfnEnvironment_OptionSettingProperty struct {
	// A unique namespace that identifies the option's associated AWS resource.
	Namespace *string `json:"namespace" yaml:"namespace"`
	// The name of the configuration option.
	OptionName *string `json:"optionName" yaml:"optionName"`
	// A unique resource name for the option setting.
	//
	// Use it for a time–based scaling configuration option.
	ResourceName *string `json:"resourceName" yaml:"resourceName"`
	// The current value for the configuration option.
	Value *string `json:"value" yaml:"value"`
}

Use the `OptionSetting` property type to specify an option for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The `OptionSetting` property type specifies an option for an AWS Elastic Beanstalk environment.

The `OptionSettings` property of the [AWS::ElasticBeanstalk::Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html) resource contains a list of `OptionSetting` property types.

For a list of possible namespaces and option values, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer Guide* .

TODO: EXAMPLE

type CfnEnvironment_TierProperty 

type CfnEnvironment_TierProperty struct {
	// The name of this environment tier.
	//
	// Valid values:
	//
	// - For *Web server tier* – `WebServer`
	// - For *Worker tier* – `Worker`
	Name *string `json:"name" yaml:"name"`
	// The type of this environment tier.
	//
	// Valid values:
	//
	// - For *Web server tier* – `Standard`
	// - For *Worker tier* – `SQS/HTTP`
	Type *string `json:"type" yaml:"type"`
	// The version of this environment tier.
	//
	// When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
	//
	// > This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
	Version *string `json:"version" yaml:"version"`
}

Use the `Tier` property type to specify the environment tier for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

Describes the environment tier for an [AWS::ElasticBeanstalk::Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html) resource. For more information, see [Environment Tiers](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html) in the *AWS Elastic Beanstalk Developer Guide* .

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.