AWS::WellArchitected::Workload

WellArchitected Workload

Definition of AWS::WellArchitected::Workload Resource Type

Properties

14 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
Description
string
Required
Environment
string
Required
Lenses
Array<string>
RequiredCreate-only
WorkloadName
string
Required
AccountIds
Array<string>
ArchitecturalDesign
string
AwsRegions
Array<string>
DiscoveryConfig
object
Industry
string
IndustryType
string
NonAwsRegions
Array<string>
Notes
string
ReviewOwner
string
Tags
Array<object>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ImprovementStatusstringThe improvement status for a workload.
WorkloadArnstringThe ARN for the workload.
WorkloadIdstringThe ID assigned to the workload.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::WellArchitected::Workload

Resources:
  MyResource:
    Type: AWS::WellArchitected::Workload
    Properties:
      WorkloadName: "my-workloadname"
      Description: "value"
      Environment: "PRODUCTION"
      Lenses: []
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

wellarchitected:CreateWorkloadwellarchitected:GetWorkloadwellarchitected:TagResourcewellarchitected:ListTagsForResource

read

wellarchitected:GetWorkloadwellarchitected:ListTagsForResource

update

wellarchitected:UpdateWorkloadwellarchitected:GetWorkloadwellarchitected:TagResourcewellarchitected:UntagResourcewellarchitected:ListTagsForResource

delete

wellarchitected:DeleteWorkloadwellarchitected:GetWorkloadwellarchitected:ListTagsForResource

list

wellarchitected:ListWorkloads

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceWellArchitected
Properties17
Required4
TaggingSupported
Primary IDWorkloadArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

Lenses

External Links