CfnEnvironmentProps

All Known Implementing Classes:: CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:09.496Z")
public interface CfnEnvironmentProps

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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnEnvironmentProps.Builder`	`builder()`
`java.lang.String`	`getApplicationName()` The name of the application that is associated with this environment.
`default java.lang.String`	`getCnamePrefix()` If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
`default java.lang.String`	`getDescription()` Your description for this environment.
`default java.lang.String`	`getEnvironmentName()` A unique name for the environment.
`default java.lang.String`	`getOperationsRole()` > The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
`default java.lang.Object`	`getOptionSettings()` Key-value pairs defining configuration options for this environment, such as the instance type.
`default java.lang.String`	`getPlatformArn()` The Amazon Resource Name (ARN) of the custom platform to use with the environment.
`default java.lang.String`	`getSolutionStackName()` The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
`default java.util.List<CfnTag>`	`getTags()` Specifies the tags applied to resources in the environment.
`default java.lang.String`	`getTemplateName()` The name of the Elastic Beanstalk configuration template to use with the environment.
`default java.lang.Object`	`getTier()` Specifies the tier to use in creating this environment.
`default java.lang.String`	`getVersionLabel()` The name of the application version to deploy.

- Method Detail
  - getApplicationName
```
java.lang.String getApplicationName()
```
    The name of the application that is associated with this environment.
  - getCnamePrefix
```
default java.lang.String getCnamePrefix()
```
    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.
  - getDescription
```
default java.lang.String getDescription()
```
    Your description for this environment.
  - getEnvironmentName
```
default java.lang.String getEnvironmentName()
```
    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 .
    
    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.
  - getOperationsRole
```
default java.lang.String getOperationsRole()
```
    > 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.
  - getOptionSettings
```
default java.lang.Object getOptionSettings()
```
    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 . If you remove any options during a stack update, the removed options retain their current values.
  - getPlatformArn
```
default java.lang.String getPlatformArn()
```
    The Amazon Resource Name (ARN) of the custom platform to use with the environment.
    For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
    
    If you specify PlatformArn , don't specify SolutionStackName .
  - getSolutionStackName
```
default java.lang.String getSolutionStackName()
```
    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 in the AWS Elastic Beanstalk Platforms guide.
    
    If you specify SolutionStackName , don't specify PlatformArn or TemplateName .
  - getTags
```
default java.util.List<CfnTag> getTags()
```
    Specifies the tags applied to resources in the environment.
  - getTemplateName
```
default java.lang.String getTemplateName()
```
    The name of the Elastic Beanstalk configuration template to use with the environment.
    
    If you specify TemplateName , then don't specify SolutionStackName .
  - getTier
```
default java.lang.Object getTier()
```
    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.
  - getVersionLabel
```
default java.lang.String getVersionLabel()
```
    The name of the application version to deploy.
    Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
  - builder
```
static CfnEnvironmentProps.Builder builder()
```
    Returns:
    
    a CfnEnvironmentProps.Builder of CfnEnvironmentProps

Interface CfnEnvironmentProps

Nested Class Summary

Method Summary

Method Detail

getApplicationName

getCnamePrefix

getDescription

getEnvironmentName

getOperationsRole

getOptionSettings

getPlatformArn

getSolutionStackName

getTags

getTemplateName

getTier

getVersionLabel

builder