Struct aws_sdk_proton::operation::create_environment::CreateEnvironmentInput

#[non_exhaustive]
pub struct CreateEnvironmentInput {
    pub name: Option<String>,
    pub template_name: Option<String>,
    pub template_major_version: Option<String>,
    pub template_minor_version: Option<String>,
    pub description: Option<String>,
    pub spec: Option<String>,
    pub proton_service_role_arn: Option<String>,
    pub environment_account_connection_id: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub provisioning_repository: Option<RepositoryBranchInput>,
    pub component_role_arn: Option<String>,
    pub codebuild_role_arn: 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.

name: Option<String>

The name of the environment.

template_name: Option<String>

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

template_major_version: Option<String>

The major version of the environment template.

template_minor_version: Option<String>

The minor version of the environment template.

description: Option<String>

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

spec: Option<String>

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.

proton_service_role_arn: Option<String>

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.

environment_account_connection_id: Option<String>

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.

tags: Option<Vec<Tag>>

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.

provisioning_repository: Option<RepositoryBranchInput>

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.

component_role_arn: Option<String>

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.

codebuild_role_arn: Option<String>

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.

Implementations

impl CreateEnvironmentInput

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

The name of the environment.

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

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

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

The major version of the environment template.

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

The minor version of the environment template.

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

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

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

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) -> Option<&str>

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) -> Option<&str>

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) -> &[Tag]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn provisioning_repository(&self) -> Option<&RepositoryBranchInput>

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) -> Option<&str>

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) -> Option<&str>

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.

impl CreateEnvironmentInput

pub fn builder() -> CreateEnvironmentInputBuilder

Creates a new builder-style object to manufacture CreateEnvironmentInput.

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 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateEnvironmentInput