Documentation ¶
Index ¶
- func CfnApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApplicationVersion_IsCfnElement(x interface{}) *bool
- func CfnApplicationVersion_IsCfnResource(x interface{}) *bool
- func CfnApplicationVersion_IsConstruct(x interface{}) *bool
- func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApplication_IsCfnElement(x interface{}) *bool
- func CfnApplication_IsCfnResource(x interface{}) *bool
- func CfnApplication_IsConstruct(x interface{}) *bool
- func CfnConfigurationTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfigurationTemplate_IsCfnElement(x interface{}) *bool
- func CfnConfigurationTemplate_IsCfnResource(x interface{}) *bool
- func CfnConfigurationTemplate_IsConstruct(x interface{}) *bool
- func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironment_IsCfnElement(x interface{}) *bool
- func CfnEnvironment_IsCfnResource(x interface{}) *bool
- func CfnEnvironment_IsConstruct(x interface{}) *bool
- func NewCfnApplicationVersion_Override(c CfnApplicationVersion, scope constructs.Construct, id *string, ...)
- func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, ...)
- func NewCfnConfigurationTemplate_Override(c CfnConfigurationTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, ...)
- type CfnApplication
- type CfnApplicationProps
- type CfnApplicationVersion
- type CfnApplicationVersionProps
- type CfnApplicationVersion_SourceBundleProperty
- type CfnApplication_ApplicationResourceLifecycleConfigProperty
- type CfnApplication_ApplicationVersionLifecycleConfigProperty
- type CfnApplication_MaxAgeRuleProperty
- type CfnApplication_MaxCountRuleProperty
- type CfnConfigurationTemplate
- type CfnConfigurationTemplateProps
- type CfnConfigurationTemplate_ConfigurationOptionSettingProperty
- type CfnConfigurationTemplate_SourceConfigurationProperty
- type CfnEnvironment
- type CfnEnvironmentProps
- type CfnEnvironment_OptionSettingProperty
- type CfnEnvironment_TierProperty
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.
func CfnApplicationVersion_IsCfnResource ¶
func CfnApplicationVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApplicationVersion_IsConstruct ¶
func CfnApplicationVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApplication_IsConstruct ¶
func CfnApplication_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnConfigurationTemplate_IsCfnResource ¶
func CfnConfigurationTemplate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnConfigurationTemplate_IsConstruct ¶
func CfnConfigurationTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironment_IsConstruct ¶
func CfnEnvironment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnApplicationVersion_Override ¶
func NewCfnApplicationVersion_Override(c CfnApplicationVersion, scope constructs.Construct, id *string, props *CfnApplicationVersionProps)
func NewCfnApplication_Override ¶
func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, props *CfnApplicationProps)
func NewCfnConfigurationTemplate_Override ¶
func NewCfnConfigurationTemplate_Override(c CfnConfigurationTemplate, scope constructs.Construct, id *string, props *CfnConfigurationTemplateProps)
func NewCfnEnvironment_Override ¶
func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)
Types ¶
type CfnApplication ¶
type CfnApplication interface { awscdk.CfnResource awscdk.IInspectable // A name for the Elastic Beanstalk application. ApplicationName() *string SetApplicationName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Your description of the application. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. ResourceLifecycleConfig() interface{} SetResourceLifecycleConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplication := awscdk.Aws_elasticbeanstalk.NewCfnApplication(this, jsii.String("MyCfnApplication"), &CfnApplicationProps{ ApplicationName: jsii.String("applicationName"), Description: jsii.String("description"), ResourceLifecycleConfig: &ApplicationResourceLifecycleConfigProperty{ ServiceRole: jsii.String("serviceRole"), VersionLifecycleConfig: &ApplicationVersionLifecycleConfigProperty{ MaxAgeRule: &MaxAgeRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxAgeInDays: jsii.Number(123), }, MaxCountRule: &MaxCountRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxCount: jsii.Number(123), }, }, }, })
func NewCfnApplication ¶
func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-applicationname // ApplicationName *string `field:"optional" json:"applicationName" yaml:"applicationName"` // Your description of the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-description // Description *string `field:"optional" json:"description" yaml:"description"` // Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-resourcelifecycleconfig // ResourceLifecycleConfig interface{} `field:"optional" json:"resourceLifecycleConfig" yaml:"resourceLifecycleConfig"` }
Properties for defining a `CfnApplication`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationProps := &CfnApplicationProps{ ApplicationName: jsii.String("applicationName"), Description: jsii.String("description"), ResourceLifecycleConfig: &ApplicationResourceLifecycleConfigProperty{ ServiceRole: jsii.String("serviceRole"), VersionLifecycleConfig: &ApplicationVersionLifecycleConfigProperty{ MaxAgeRule: &MaxAgeRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxAgeInDays: jsii.Number(123), }, MaxCountRule: &MaxCountRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxCount: jsii.Number(123), }, }, }, }
type CfnApplicationVersion ¶
type CfnApplicationVersion interface { awscdk.CfnResource awscdk.IInspectable // The name of the Elastic Beanstalk application that is associated with this application version. ApplicationName() *string SetApplicationName(val *string) AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of this application version. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon S3 bucket and key that identify the location of the source bundle for this version. SourceBundle() interface{} SetSourceBundle(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationVersion := awscdk.Aws_elasticbeanstalk.NewCfnApplicationVersion(this, jsii.String("MyCfnApplicationVersion"), &CfnApplicationVersionProps{ ApplicationName: jsii.String("applicationName"), SourceBundle: &SourceBundleProperty{ S3Bucket: jsii.String("s3Bucket"), S3Key: jsii.String("s3Key"), }, // the properties below are optional Description: jsii.String("description"), })
func NewCfnApplicationVersion ¶
func NewCfnApplicationVersion(scope constructs.Construct, id *string, props *CfnApplicationVersionProps) CfnApplicationVersion
type CfnApplicationVersionProps ¶
type CfnApplicationVersionProps struct { // The name of the Elastic Beanstalk application that is associated with this application version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-applicationname // ApplicationName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-sourcebundle // SourceBundle interface{} `field:"required" json:"sourceBundle" yaml:"sourceBundle"` // A description of this application version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-description // Description *string `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `CfnApplicationVersion`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationVersionProps := &CfnApplicationVersionProps{ ApplicationName: jsii.String("applicationName"), SourceBundle: &SourceBundleProperty{ S3Bucket: jsii.String("s3Bucket"), S3Key: jsii.String("s3Key"), }, // the properties below are optional Description: jsii.String("description"), }
type CfnApplicationVersion_SourceBundleProperty ¶
type CfnApplicationVersion_SourceBundleProperty struct { // The Amazon S3 bucket where the data is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3bucket // S3Bucket *string `field:"required" json:"s3Bucket" yaml:"s3Bucket"` // The Amazon S3 key where the data is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3key // S3Key *string `field:"required" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceBundleProperty := &SourceBundleProperty{ S3Bucket: jsii.String("s3Bucket"), S3Key: jsii.String("s3Key"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole // ServiceRole *string `field:"optional" json:"serviceRole" yaml:"serviceRole"` // Defines lifecycle settings for application versions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-versionlifecycleconfig // VersionLifecycleConfig interface{} `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" applicationResourceLifecycleConfigProperty := &ApplicationResourceLifecycleConfigProperty{ ServiceRole: jsii.String("serviceRole"), VersionLifecycleConfig: &ApplicationVersionLifecycleConfigProperty{ MaxAgeRule: &MaxAgeRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxAgeInDays: jsii.Number(123), }, MaxCountRule: &MaxCountRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxCount: jsii.Number(123), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxagerule // MaxAgeRule interface{} `field:"optional" json:"maxAgeRule" yaml:"maxAgeRule"` // Specify a max count rule to restrict the number of application versions that are retained for an application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxcountrule // MaxCountRule interface{} `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" applicationVersionLifecycleConfigProperty := &ApplicationVersionLifecycleConfigProperty{ MaxAgeRule: &MaxAgeRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxAgeInDays: jsii.Number(123), }, MaxCountRule: &MaxCountRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxCount: jsii.Number(123), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-deletesourcefroms3 // DeleteSourceFromS3 interface{} `field:"optional" json:"deleteSourceFromS3" yaml:"deleteSourceFromS3"` // Specify `true` to apply the rule, or `false` to disable it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // Specify the number of days to retain an application versions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-maxageindays // MaxAgeInDays *float64 `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" maxAgeRuleProperty := &MaxAgeRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxAgeInDays: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-deletesourcefroms3 // DeleteSourceFromS3 interface{} `field:"optional" json:"deleteSourceFromS3" yaml:"deleteSourceFromS3"` // Specify `true` to apply the rule, or `false` to disable it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // Specify the maximum number of application versions to retain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-maxcount // MaxCount *float64 `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" maxCountRuleProperty := &MaxCountRuleProperty{ DeleteSourceFromS3: jsii.Boolean(false), Enabled: jsii.Boolean(false), MaxCount: jsii.Number(123), }
type CfnConfigurationTemplate ¶
type CfnConfigurationTemplate interface { awscdk.CfnResource awscdk.IInspectable // The name of the Elastic Beanstalk application to associate with this configuration template. ApplicationName() *string SetApplicationName(val *string) // The name of the configuration template. // // Constraint: This name must be unique per application. AttrTemplateName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An optional description for this configuration. Description() *string SetDescription(val *string) // The ID of an environment whose settings you want to use to create the configuration template. EnvironmentId() *string SetEnvironmentId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Option values for the Elastic Beanstalk configuration, such as the instance type. OptionSettings() interface{} SetOptionSettings(val interface{}) // The Amazon Resource Name (ARN) of the custom platform. PlatformArn() *string SetPlatformArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. SolutionStackName() *string SetSolutionStackName(val *string) // An Elastic Beanstalk configuration template to base this one on. SourceConfiguration() interface{} SetSourceConfiguration(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfigurationTemplate := awscdk.Aws_elasticbeanstalk.NewCfnConfigurationTemplate(this, jsii.String("MyCfnConfigurationTemplate"), &CfnConfigurationTemplateProps{ ApplicationName: jsii.String("applicationName"), // the properties below are optional Description: jsii.String("description"), EnvironmentId: jsii.String("environmentId"), OptionSettings: []interface{}{ &ConfigurationOptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }, }, PlatformArn: jsii.String("platformArn"), SolutionStackName: jsii.String("solutionStackName"), SourceConfiguration: &SourceConfigurationProperty{ ApplicationName: jsii.String("applicationName"), TemplateName: jsii.String("templateName"), }, })
func NewCfnConfigurationTemplate ¶
func NewCfnConfigurationTemplate(scope constructs.Construct, id *string, props *CfnConfigurationTemplateProps) CfnConfigurationTemplate
type CfnConfigurationTemplateProps ¶
type CfnConfigurationTemplateProps struct { // The name of the Elastic Beanstalk application to associate with this configuration template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-applicationname // ApplicationName *string `field:"required" json:"applicationName" yaml:"applicationName"` // An optional description for this configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-description // Description *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-environmentid // EnvironmentId *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-optionsettings // OptionSettings interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-platformarn // PlatformArn *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-solutionstackname // SolutionStackName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration // SourceConfiguration interface{} `field:"optional" json:"sourceConfiguration" yaml:"sourceConfiguration"` }
Properties for defining a `CfnConfigurationTemplate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfigurationTemplateProps := &CfnConfigurationTemplateProps{ ApplicationName: jsii.String("applicationName"), // the properties below are optional Description: jsii.String("description"), EnvironmentId: jsii.String("environmentId"), OptionSettings: []interface{}{ &ConfigurationOptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }, }, PlatformArn: jsii.String("platformArn"), SolutionStackName: jsii.String("solutionStackName"), SourceConfiguration: &SourceConfigurationProperty{ ApplicationName: jsii.String("applicationName"), TemplateName: jsii.String("templateName"), }, }
type CfnConfigurationTemplate_ConfigurationOptionSettingProperty ¶
type CfnConfigurationTemplate_ConfigurationOptionSettingProperty struct { // A unique namespace that identifies the option's associated AWS resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-namespace // Namespace *string `field:"required" json:"namespace" yaml:"namespace"` // The name of the configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-optionname // OptionName *string `field:"required" json:"optionName" yaml:"optionName"` // A unique resource name for the option setting. // // Use it for a time–based scaling configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-resourcename // ResourceName *string `field:"optional" json:"resourceName" yaml:"resourceName"` // The current value for the configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-value // Value *string `field:"optional" 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" configurationOptionSettingProperty := &ConfigurationOptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }
type CfnConfigurationTemplate_SourceConfigurationProperty ¶
type CfnConfigurationTemplate_SourceConfigurationProperty struct { // The name of the application associated with the configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-applicationname // ApplicationName *string `field:"required" json:"applicationName" yaml:"applicationName"` // The name of the configuration template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-templatename // TemplateName *string `field:"required" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceConfigurationProperty := &SourceConfigurationProperty{ ApplicationName: jsii.String("applicationName"), TemplateName: jsii.String("templateName"), }
type CfnEnvironment ¶
type CfnEnvironment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name of the application that is associated with this environment. ApplicationName() *string SetApplicationName(val *string) // For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance. // // Example load balancer URL: // // Example instance IP address: // // `192.0.2.0` AttrEndpointUrl() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. CnamePrefix() *string SetCnamePrefix(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Your description for this environment. Description() *string SetDescription(val *string) // A unique name for the environment. EnvironmentName() *string SetEnvironmentName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // > The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change. OperationsRole() *string SetOperationsRole(val *string) // Key-value pairs defining configuration options for this environment, such as the instance type. OptionSettings() interface{} SetOptionSettings(val interface{}) // The Amazon Resource Name (ARN) of the custom platform to use with the environment. PlatformArn() *string SetPlatformArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. SolutionStackName() *string SetSolutionStackName(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Specifies the tags applied to resources in the environment. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The name of the Elastic Beanstalk configuration template to use with the environment. TemplateName() *string SetTemplateName(val *string) // Specifies the tier to use in creating this environment. Tier() interface{} SetTier(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The name of the application version to deploy. VersionLabel() *string SetVersionLabel(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironment := awscdk.Aws_elasticbeanstalk.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{ ApplicationName: jsii.String("applicationName"), // the properties below are optional CnamePrefix: jsii.String("cnamePrefix"), Description: jsii.String("description"), EnvironmentName: jsii.String("environmentName"), OperationsRole: jsii.String("operationsRole"), OptionSettings: []interface{}{ &OptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }, }, PlatformArn: jsii.String("platformArn"), SolutionStackName: jsii.String("solutionStackName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TemplateName: jsii.String("templateName"), Tier: &TierProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Version: jsii.String("version"), }, VersionLabel: jsii.String("versionLabel"), })
func NewCfnEnvironment ¶
func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
type CfnEnvironmentProps ¶
type CfnEnvironmentProps struct { // The name of the application that is associated with this environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-applicationname // ApplicationName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-cnameprefix // CnamePrefix *string `field:"optional" json:"cnamePrefix" yaml:"cnamePrefix"` // Your description for this environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-description // Description *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-environmentname // EnvironmentName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-operationsrole // OperationsRole *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-optionsettings // OptionSettings interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-platformarn // PlatformArn *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-solutionstackname // SolutionStackName *string `field:"optional" json:"solutionStackName" yaml:"solutionStackName"` // Specifies the tags applied to resources in the environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tags // Tags *[]*awscdk.CfnTag `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-templatename // TemplateName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tier // Tier interface{} `field:"optional" json:"tier" yaml:"tier"` // The name of the application version to deploy. // // Default: If not specified, Elastic Beanstalk attempts to deploy the sample application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-versionlabel // VersionLabel *string `field:"optional" json:"versionLabel" yaml:"versionLabel"` }
Properties for defining a `CfnEnvironment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentProps := &CfnEnvironmentProps{ ApplicationName: jsii.String("applicationName"), // the properties below are optional CnamePrefix: jsii.String("cnamePrefix"), Description: jsii.String("description"), EnvironmentName: jsii.String("environmentName"), OperationsRole: jsii.String("operationsRole"), OptionSettings: []interface{}{ &OptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }, }, PlatformArn: jsii.String("platformArn"), SolutionStackName: jsii.String("solutionStackName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TemplateName: jsii.String("templateName"), Tier: &TierProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Version: jsii.String("version"), }, VersionLabel: jsii.String("versionLabel"), }
type CfnEnvironment_OptionSettingProperty ¶
type CfnEnvironment_OptionSettingProperty struct { // A unique namespace that identifies the option's associated AWS resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-namespace // Namespace *string `field:"required" json:"namespace" yaml:"namespace"` // The name of the configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-optionname // OptionName *string `field:"required" json:"optionName" yaml:"optionName"` // A unique resource name for the option setting. // // Use it for a time–based scaling configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename // ResourceName *string `field:"optional" json:"resourceName" yaml:"resourceName"` // The current value for the configuration option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-value // Value *string `field:"optional" 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" optionSettingProperty := &OptionSettingProperty{ Namespace: jsii.String("namespace"), OptionName: jsii.String("optionName"), // the properties below are optional ResourceName: jsii.String("resourceName"), Value: jsii.String("value"), }
type CfnEnvironment_TierProperty ¶
type CfnEnvironment_TierProperty struct { // The name of this environment tier. // // Valid values: // // - For *Web server tier* – `WebServer` // - For *Worker tier* – `Worker`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-name // Name *string `field:"optional" json:"name" yaml:"name"` // The type of this environment tier. // // Valid values: // // - For *Web server tier* – `Standard` // - For *Worker tier* – `SQS/HTTP`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-type // Type *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-version // Version *string `field:"optional" 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tierProperty := &TierProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Version: jsii.String("version"), }
Source Files ¶
- CfnApplication.go
- CfnApplicationProps.go
- CfnApplicationVersion.go
- CfnApplicationVersionProps.go
- CfnApplicationVersion_SourceBundleProperty.go
- CfnApplicationVersion__checks.go
- CfnApplication_ApplicationResourceLifecycleConfigProperty.go
- CfnApplication_ApplicationVersionLifecycleConfigProperty.go
- CfnApplication_MaxAgeRuleProperty.go
- CfnApplication_MaxCountRuleProperty.go
- CfnApplication__checks.go
- CfnConfigurationTemplate.go
- CfnConfigurationTemplateProps.go
- CfnConfigurationTemplate_ConfigurationOptionSettingProperty.go
- CfnConfigurationTemplate_SourceConfigurationProperty.go
- CfnConfigurationTemplate__checks.go
- CfnEnvironment.go
- CfnEnvironmentProps.go
- CfnEnvironment_OptionSettingProperty.go
- CfnEnvironment_TierProperty.go
- CfnEnvironment__checks.go
- main.go