software.amazon.awscdk.services.elasticbeanstalk

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.421Z")
 @Stability(value=Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ElasticBeanstalk::Environment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticbeanstalk.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .applicationName("applicationName")
         // the properties below are optional
         .cnamePrefix("cnamePrefix")
         .description("description")
         .environmentName("environmentName")
         .operationsRole("operationsRole")
         .optionSettings(List.of(OptionSettingProperty.builder()
                 .namespace("namespace")
                 .optionName("optionName")
                 // the properties below are optional
                 .resourceName("resourceName")
                 .value("value")
                 .build()))
         .platformArn("platformArn")
         .solutionStackName("solutionStackName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateName("templateName")
         .tier(TierProperty.builder()
                 .name("name")
                 .type("type")
                 .version("version")
                 .build())
         .versionLabel("versionLabel")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEnvironmentProps.Builder A builder for CfnEnvironmentProps
static class	CfnEnvironmentProps.Jsii$Proxy An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method and Description
static CfnEnvironmentProps.Builder	builder()
String	getApplicationName() `AWS::ElasticBeanstalk::Environment.ApplicationName`.
default String	getCnamePrefix() `AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.
default String	getDescription() `AWS::ElasticBeanstalk::Environment.Description`.
default String	getEnvironmentName() `AWS::ElasticBeanstalk::Environment.EnvironmentName`.
default String	getOperationsRole() `AWS::ElasticBeanstalk::Environment.OperationsRole`.
default Object	getOptionSettings() `AWS::ElasticBeanstalk::Environment.OptionSettings`.
default String	getPlatformArn() `AWS::ElasticBeanstalk::Environment.PlatformArn`.
default String	getSolutionStackName() `AWS::ElasticBeanstalk::Environment.SolutionStackName`.
default List<CfnTag>	getTags() `AWS::ElasticBeanstalk::Environment.Tags`.
default String	getTemplateName() `AWS::ElasticBeanstalk::Environment.TemplateName`.
default Object	getTier() `AWS::ElasticBeanstalk::Environment.Tier`.
default String	getVersionLabel() `AWS::ElasticBeanstalk::Environment.VersionLabel`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApplicationName

@Stability(value=Stable)
 @NotNull
String getApplicationName()

`AWS::ElasticBeanstalk::Environment.ApplicationName`.

getCnamePrefix

@Stability(value=Stable)
 @Nullable
default String getCnamePrefix()

`AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::ElasticBeanstalk::Environment.Description`.

getEnvironmentName

@Stability(value=Stable)
 @Nullable
default String getEnvironmentName()

`AWS::ElasticBeanstalk::Environment.EnvironmentName`.

getOperationsRole

@Stability(value=Stable)
 @Nullable
default String getOperationsRole()

`AWS::ElasticBeanstalk::Environment.OperationsRole`.

getOptionSettings

@Stability(value=Stable)
 @Nullable
default Object getOptionSettings()

`AWS::ElasticBeanstalk::Environment.OptionSettings`.

getPlatformArn

@Stability(value=Stable)
 @Nullable
default String getPlatformArn()

`AWS::ElasticBeanstalk::Environment.PlatformArn`.

getSolutionStackName

@Stability(value=Stable)
 @Nullable
default String getSolutionStackName()

`AWS::ElasticBeanstalk::Environment.SolutionStackName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::ElasticBeanstalk::Environment.Tags`.

getTemplateName

@Stability(value=Stable)
 @Nullable
default String getTemplateName()

`AWS::ElasticBeanstalk::Environment.TemplateName`.

getTier

@Stability(value=Stable)
 @Nullable
default Object getTier()

`AWS::ElasticBeanstalk::Environment.Tier`.

getVersionLabel

@Stability(value=Stable)
 @Nullable
default String getVersionLabel()

`AWS::ElasticBeanstalk::Environment.VersionLabel`.

builder

@Stability(value=Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps