Struct aws_sdk_elasticbeanstalk::input::CreateEnvironmentInput

#[non_exhaustive]
pub struct CreateEnvironmentInput {

    pub application_name: Option<String>,
    pub environment_name: Option<String>,
    pub group_name: Option<String>,
    pub description: Option<String>,
    pub cname_prefix: Option<String>,
    pub tier: Option<EnvironmentTier>,
    pub tags: Option<Vec<Tag>>,
    pub version_label: Option<String>,
    pub template_name: Option<String>,
    pub solution_stack_name: Option<String>,
    pub platform_arn: Option<String>,
    pub option_settings: Option<Vec<ConfigurationOptionSetting>>,
    pub options_to_remove: Option<Vec<OptionSpecification>>,
    pub operations_role: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_name: Option<String>

The name of the application that is associated with this environment.

environment_name: Option<String>

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 the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.

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.

group_name: Option<String>

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

description: Option<String>

Your description for this environment.

cname_prefix: Option<String>

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.

tier: Option<EnvironmentTier>

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.

tags: Option<Vec<Tag>>

Specifies the tags applied to resources in the environment.

version_label: Option<String>

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

template_name: Option<String>

The name of the Elastic Beanstalk configuration template to use with the environment.

If you specify TemplateName, then don't specify SolutionStackName.

solution_stack_name: Option<String>

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.

platform_arn: Option<String>

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.

option_settings: Option<Vec<ConfigurationOptionSetting>>

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

options_to_remove: Option<Vec<OptionSpecification>>

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

operations_role: Option<String>

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Implementations

impl CreateEnvironmentInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateEnvironment, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateEnvironment>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateEnvironmentInput

impl CreateEnvironmentInput

pub fn application_name(&self) -> Option<&str>

The name of the application that is associated with this environment.

pub fn environment_name(&self) -> Option<&str>

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 the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.

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.

pub fn group_name(&self) -> Option<&str>

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

pub fn description(&self) -> Option<&str>

Your description for this environment.

pub fn cname_prefix(&self) -> Option<&str>

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.

pub fn tier(&self) -> Option<&EnvironmentTier>

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.

pub fn tags(&self) -> Option<&[Tag]>

Specifies the tags applied to resources in the environment.

pub fn version_label(&self) -> Option<&str>

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

pub fn template_name(&self) -> Option<&str>

The name of the Elastic Beanstalk configuration template to use with the environment.

If you specify TemplateName, then don't specify SolutionStackName.

pub fn solution_stack_name(&self) -> Option<&str>

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.

pub fn platform_arn(&self) -> Option<&str>

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.

pub fn option_settings(&self) -> Option<&[ConfigurationOptionSetting]>

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

pub fn options_to_remove(&self) -> Option<&[OptionSpecification]>

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

pub fn operations_role(&self) -> Option<&str>

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Trait Implementations

impl Clone for CreateEnvironmentInput

fn clone(&self) -> CreateEnvironmentInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateEnvironmentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateEnvironmentInput> for CreateEnvironmentInput

fn eq(&self, other: &CreateEnvironmentInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateEnvironmentInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateEnvironmentInput