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

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

Overview

Input for workload creation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

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

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#applicationsArray<String>

List of AppRegistry application ARNs associated to the workload.

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#architectural_designString

The URL of the architectural design for the workload.

Returns:

  • (String)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#aws_regionsArray<String>

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

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#descriptionString

The description for the workload.

Returns:

  • (String)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#discovery_configTypes::WorkloadDiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#environmentString

The environment for the workload.

Returns:

  • (String)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#industryString

The industry for the workload.

Returns:

  • (String)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

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


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#non_aws_regionsArray<String>

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

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#notesString

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)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#profile_arnsArray<String>

The list of profile ARNs associated with the workload.

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#review_template_arnsArray<String>

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

Returns:

  • (Array<String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#tagsHash<String,String>

The tags to be associated with the workload.

Returns:

  • (Hash<String,String>)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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

#workload_nameString

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)


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 1277

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