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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb

Overview

Note:

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

{
  workload_name: "WorkloadName", # required
  description: "WorkloadDescription", # required
  environment: "PRODUCTION", # required, accepts PRODUCTION, PREPRODUCTION
  account_ids: ["AwsAccountId"],
  aws_regions: ["AwsRegion"],
  non_aws_regions: ["WorkloadNonAwsRegion"],
  pillar_priorities: ["PillarId"],
  architectural_design: "WorkloadArchitecturalDesign",
  review_owner: "WorkloadReviewOwner", # required
  industry_type: "WorkloadIndustryType",
  industry: "WorkloadIndustry",
  lenses: ["LensAlias"], # required
  notes: "Notes",
  client_request_token: "ClientRequestToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
}

Input for workload creation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

The list of AWS account IDs associated with the workload.

Returns:

  • (Array<String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#architectural_designString

The URL of the architectural design for the workload.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#aws_regionsArray<String>

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

Returns:

  • (Array<String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the workload.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#environmentString

The environment for the workload.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#industryString

The industry for the workload.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#industry_typeString

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)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#lensesArray<String>

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

Returns:

  • (Array<String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#non_aws_regionsArray<String>

The list of non-AWS Regions associated with the workload.

Returns:

  • (Array<String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#notesString

The notes associated with the workload.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#pillar_prioritiesArray<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>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#review_ownerString

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)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags to be associated with the workload.

Returns:

  • (Hash<String,String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end

#workload_nameString

The name of the workload.

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

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 572

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)
  SENSITIVE = []
  include Aws::Structure
end