Class: Aws::WellArchitected::Types::CreateAgentProfileRequest

Inherits:

Struct

• Object
• Struct
• Aws::WellArchitected::Types::CreateAgentProfileRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name, :description, :business_overview]

Instance Attribute Summary

• #aggregation_configuration ⇒ Array<Types::AggregationConfiguration>

  The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

• #business_overview ⇒ String

  The business overview for this profile.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #deletion_protection ⇒ Boolean

  Indicates whether deletion protection is enabled for the profile.

• #description ⇒ String

  A description of the profile.

• #display_name ⇒ String

  The display name of the profile shown to users.

• #execution_role_arn ⇒ String

  The ARN of the IAM execution role used for recommendation actions.

• #name ⇒ String

  The system name of the profile.

• #pillars ⇒ Array<String>

  The Well-Architected Tool Framework pillars to associate with this profile.

• #tags ⇒ Array<Types::Tag>

  The tags to associate with the profile.

Instance Attribute Details

#aggregation_configuration ⇒ Array<Types::AggregationConfiguration>

The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

Returns:

• (Array<Types::AggregationConfiguration>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#business_overview ⇒ String

The business overview for this profile.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

Indicates whether deletion protection is enabled for the profile.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#description ⇒ String

A description of the profile.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the profile shown to users.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#execution_role_arn ⇒ String

The ARN of the IAM execution role used for recommendation actions.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#name ⇒ String

The system name of the profile.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#pillars ⇒ Array<String>

The Well-Architected Tool Framework pillars to associate with this profile.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to associate with the profile.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1466

class CreateAgentProfileRequest < Struct.new(
  :name,
  :display_name,
  :description,
  :business_overview,
  :pillars,
  :deletion_protection,
  :execution_role_arn,
  :aggregation_configuration,
  :client_token,
  :tags)
  SENSITIVE = [:display_name, :description, :business_overview]
  include Aws::Structure
end