Class: Aws::WellArchitected::Types::CreateWorkloadInput

Inherits:

Struct

• Object
• Struct
• Aws::WellArchitected::Types::CreateWorkloadInput

Defined in:

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

Overview

Input for workload creation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_ids ⇒ Array<String>

  The list of Amazon Web Services account IDs associated with the workload.

• #applications ⇒ Array<String>

  List of AppRegistry application ARNs associated to the workload.

• #architectural_design ⇒ String

  The URL of the architectural design for the workload.

• #aws_regions ⇒ Array<String>

  The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

• #client_request_token ⇒ String

  A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

• #description ⇒ String

  The description for the workload.

• #discovery_config ⇒ Types::WorkloadDiscoveryConfig

  Well-Architected discovery configuration settings associated to the workload.

• #environment ⇒ String

  The environment for the workload.

• #industry ⇒ String

  The industry for the workload.

• #industry_type ⇒ String

  The industry type for the workload.

• #jira_configuration ⇒ Types::WorkloadJiraConfigurationInput

  Jira configuration settings when creating a workload.

• #lenses ⇒ Array<String>

  The list of lenses associated with the workload.

• #non_aws_regions ⇒ Array<String>

  The list of non-Amazon Web Services Regions associated with the workload.

• #notes ⇒ String

  The notes associated with the workload.

• #pillar_priorities ⇒ Array<String>

  The priorities of the pillars, which are used to order items in the improvement plan.

• #profile_arns ⇒ Array<String>

  The list of profile ARNs associated with the workload.

• #review_owner ⇒ String

  The review owner of the workload.

• #review_template_arns ⇒ Array<String>

  The list of review template ARNs to associate with the workload.

• #tags ⇒ Hash<String,String>

  The tags to be associated with the workload.

• #workload_name ⇒ String

  The name of the workload.

Instance Attribute Details

#account_ids ⇒ Array<String>

The list of Amazon Web Services account IDs associated with the workload.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#applications ⇒ Array<String>

List of AppRegistry application ARNs associated to the workload.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#architectural_design ⇒ String

The URL of the architectural design for the workload.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#aws_regions ⇒ Array<String>

The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

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 1360

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the workload.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#discovery_config ⇒ Types::WorkloadDiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.

Returns:

• (Types::WorkloadDiscoveryConfig)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ String

The environment for the workload.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#industry ⇒ String

The industry for the workload.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#industry_type ⇒ String

The industry type for the workload.

If specified, must be one of the following:

• Agriculture

• Automobile

• Defense

• Design and Engineering

• Digital Advertising

• Education

• Environmental Protection

• Financial Services

• Gaming

• General Public Services

• Healthcare

• Hospitality

• InfoTech

• Justice and Public Safety

• Life Sciences

• Manufacturing

• Media & Entertainment

• Mining & Resources

• Oil & Gas

• Power & Utilities

• Professional Services

• Real Estate & Construction

• Retail & Wholesale

• Social Protection

• Telecommunications

• Travel, Transportation & Logistics

• Other

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#jira_configuration ⇒ Types::WorkloadJiraConfigurationInput

Jira configuration settings when creating a workload.

Returns:

• (Types::WorkloadJiraConfigurationInput)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lenses ⇒ Array<String>

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#non_aws_regions ⇒ Array<String>

The list of non-Amazon Web Services Regions associated with the workload.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notes ⇒ String

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#pillar_priorities ⇒ Array<String>

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#profile_arns ⇒ Array<String>

The list of profile ARNs associated with the workload.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#review_owner ⇒ String

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#review_template_arns ⇒ Array<String>

The list of review template ARNs to associate with the workload.

Returns:

• (Array<String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags to be associated with the workload.

Returns:

• (Hash<String,String>)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#workload_name ⇒ String

The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

Returns:

• (String)

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

class CreateWorkloadInput < Struct.new(
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :industry_type,
  :industry,
  :lenses,
  :notes,
  :client_request_token,
  :tags,
  :discovery_config,
  :applications,
  :profile_arns,
  :review_template_arns,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end