aws_sdk_proton/client/
create_environment_account_connection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateEnvironmentAccountConnection`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_client_token):<br>required: **false**<br><p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.</p><br>
7    ///   - [`management_account_id(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::management_account_id) / [`set_management_account_id(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_management_account_id):<br>required: **true**<br><p>The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p><br>
8    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.</p><br>
9    ///   - [`environment_name(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::environment_name) / [`set_environment_name(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_environment_name):<br>required: **true**<br><p>The name of the Proton environment that's created in the associated management account.</p><br>
10    ///   - [`tags(Tag)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_tags):<br>required: **false**<br><p>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</p><br>
11    ///   - [`component_role_arn(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::component_role_arn) / [`set_component_role_arn(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_component_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.</p> <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in this account.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p><br>
12    ///   - [`codebuild_role_arn(impl Into<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::codebuild_role_arn) / [`set_codebuild_role_arn(Option<String>)`](crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::set_codebuild_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.</p><br>
13    /// - On success, responds with [`CreateEnvironmentAccountConnectionOutput`](crate::operation::create_environment_account_connection::CreateEnvironmentAccountConnectionOutput) with field(s):
14    ///   - [`environment_account_connection(Option<EnvironmentAccountConnection>)`](crate::operation::create_environment_account_connection::CreateEnvironmentAccountConnectionOutput::environment_account_connection): <p>The environment account connection detail data that's returned by Proton.</p>
15    /// - On failure, responds with [`SdkError<CreateEnvironmentAccountConnectionError>`](crate::operation::create_environment_account_connection::CreateEnvironmentAccountConnectionError)
16    pub fn create_environment_account_connection(
17        &self,
18    ) -> crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder {
19        crate::operation::create_environment_account_connection::builders::CreateEnvironmentAccountConnectionFluentBuilder::new(self.handle.clone())
20    }
21}