Class: Aws::Proton::Types::CreateEnvironmentAccountConnectionInput

Inherits:

Struct

• Object
• Struct
• Aws::Proton::Types::CreateEnvironmentAccountConnectionInput

Defined in:

gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb

Overview

Note:

When making an API call, you may pass CreateEnvironmentAccountConnectionInput data as a hash:

{
  client_token: "ClientToken",
  component_role_arn: "Arn",
  environment_name: "ResourceName", # required
  management_account_id: "AwsAccountId", # required
  role_arn: "Arn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.

• #component_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account.

• #environment_name ⇒ String

  The name of the Proton environment that's created in the associated management account.

• #management_account_id ⇒ String

  The ID of the management account that accepts or rejects the environment account connection.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account.

• #tags ⇒ Array<Types::Tag>

  An optional list of metadata items that you can associate with the Proton environment account connection.

Instance Attribute Details

#client_token ⇒ String

When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#component_role_arn ⇒ String

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.

You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

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

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

The name of the Proton environment that's created in the associated management account.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#management_account_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 625

class CreateEnvironmentAccountConnectionInput < Struct.new(
  :client_token,
  :component_role_arn,
  :environment_name,
  :management_account_id,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end