AWS::WellArchitected::Workload

Input for workload creation.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::WellArchitected::Workload",
  "Properties" : {
      "AccountIds" : [ String, ... ],
      "ArchitecturalDesign" : String,
      "AwsRegions" : [ String, ... ],
      "Description" : String,
      "DiscoveryConfig" : DiscoveryConfig,
      "Environment" : String,
      "Industry" : String,
      "IndustryType" : String,
      "Lenses" : [ String, ... ],
      "NonAwsRegions" : [ String, ... ],
      "Notes" : String,
      "ReviewOwner" : String,
      "Tags" : [ TagsItems, ... ],
      "WorkloadName" : String
    }
}

YAML

Type: AWS::WellArchitected::Workload
Properties:
  AccountIds: 
    - String
  ArchitecturalDesign: String
  AwsRegions: 
    - String
  Description: String
  DiscoveryConfig: 
    DiscoveryConfig
  Environment: String
  Industry: String
  IndustryType: String
  Lenses: 
    - String
  NonAwsRegions: 
    - String
  Notes: String
  ReviewOwner: String
  Tags: 
    - TagsItems
  WorkloadName: String

Properties

AccountIds

Property description not available.

Required: No

Type: Array of String

Minimum: 12 | 0

Maximum: 12 | 100

Update requires: No interruption

ArchitecturalDesign

Property description not available.

Required: No

Type: String

Pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$

Maximum: 2048

Update requires: No interruption

AwsRegions

Property description not available.

Required: No

Type: Array of String

Minimum: 0

Maximum: 100 | 50

Update requires: No interruption

Description

Property description not available.

Required: Yes

Type: String

Minimum: 3

Maximum: 250

Update requires: No interruption

DiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.

Required: No

Type: DiscoveryConfig

Update requires: No interruption

Environment

Property description not available.

Required: Yes

Type: String

Allowed values: PRODUCTION | PREPRODUCTION

Update requires: No interruption

Industry

Property description not available.

Required: No

Type: String

Maximum: 100

Update requires: No interruption

IndustryType

Property description not available.

Required: No

Type: String

Maximum: 100

Update requires: No interruption

Lenses

Property description not available.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 128

Update requires: Replacement

NonAwsRegions

Property description not available.

Required: No

Type: Array of String

Minimum: 3 | 0

Maximum: 25 | 5

Update requires: No interruption

Notes

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.

Required: No

Type: String

Maximum: 2084

Update requires: No interruption

ReviewOwner

Property description not available.

Required: No

Type: String

Minimum: 3

Maximum: 255

Update requires: No interruption

Tags

The tags to be associated with the workload.

Required: No

Type: Array of TagsItems

Maximum: 50

Update requires: No interruption

WorkloadName

The name of the workload.

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

Required: Yes

Type: String

Minimum: 3

Maximum: 100

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ImprovementStatus

Property description not available.

WorkloadArn

The ARN for the workload.

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.