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

Inherits:
Struct
  • Object
show all
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",
  environment_name: "ResourceName", # required
  management_account_id: "AwsAccountId", # required
  role_arn: "Arn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 304

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

#environment_nameString

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

Returns:

  • (String)


304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 304

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

#management_account_idString

The ID of the management account that accepts or rejects the environment account connection. You create an 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)


304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 304

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

#role_arnString

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)


304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 304

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

#tagsArray<Types::Tag>

Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.

Returns:



304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 304

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