Struct aws_sdk_proton::client::fluent_builders::CreateEnvironment

pub struct CreateEnvironment { /* private fields */ }

Fluent builder constructing a request to CreateEnvironment.

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

• Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.

• Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see Environments and Provisioning methods in the Proton User Guide.

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

The name of the environment.

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

The name of the environment.

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

The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

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

The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

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

The major version of the environment template.

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

The major version of the environment template.

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

The minor version of the environment template.

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

The minor version of the environment template.

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

A description of the environment that's being created and deployed.

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

A description of the environment that's being created and deployed.

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

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

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

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

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

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

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

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

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

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

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

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

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

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

pub fn provisioning_repository(self, input: RepositoryBranchInput) -> Self

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

pub fn set_provisioning_repository(
    self,
    input: Option<RepositoryBranchInput>
) -> Self

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

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

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton User Guide.

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

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton User Guide.

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

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

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

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

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.