Struct aws_sdk_elasticbeanstalk::client::fluent_builders::CreateEnvironment

pub struct CreateEnvironment { /* private fields */ }

Fluent builder constructing a request to CreateEnvironment.

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Implementations

impl CreateEnvironment

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateEnvironment, AwsResponseRetryClassifier>, SdkError<CreateEnvironmentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateEnvironmentOutput, SdkError<CreateEnvironmentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn application_name(self, input: impl Into<String>) -> Self

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

pub fn set_application_name(self, input: Option<String>) -> Self

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

pub fn environment_name(self, input: impl Into<String>) -> Self

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 set_environment_name(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_group_name(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

Your description for this environment.

pub fn set_description(self, input: Option<String>) -> Self

Your description for this environment.

pub fn cname_prefix(self, input: impl Into<String>) -> Self

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 set_cname_prefix(self, input: Option<String>) -> Self

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, input: EnvironmentTier) -> Self

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 set_tier(self, input: Option<EnvironmentTier>) -> Self

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, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Specifies the tags applied to resources in the environment.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Specifies the tags applied to resources in the environment.

pub fn version_label(self, input: impl Into<String>) -> Self

The name of the application version to deploy.

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

pub fn set_version_label(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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

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

pub fn set_template_name(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_solution_stack_name(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_platform_arn(self, input: Option<String>) -> Self

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, input: ConfigurationOptionSetting) -> Self

Appends an item to OptionSettings.

To override the contents of this collection use set_option_settings.

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 set_option_settings(
    self,
    input: Option<Vec<ConfigurationOptionSetting>>
) -> Self

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, input: OptionSpecification) -> Self

Appends an item to OptionsToRemove.

To override the contents of this collection use set_options_to_remove.

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

pub fn set_options_to_remove(
    self,
    input: Option<Vec<OptionSpecification>>
) -> Self

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

pub fn operations_role(self, input: impl Into<String>) -> Self

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.

pub fn set_operations_role(self, input: Option<String>) -> Self

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 CreateEnvironment

fn clone(&self) -> CreateEnvironment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEnvironment

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

Formats the value using the given formatter.