We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 21, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 21, 2026 by Pulumi
Definition of AWS::WellArchitected::Workload Resource Type
Create Workload Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workload(name: string, args: WorkloadArgs, opts?: CustomResourceOptions);@overload
def Workload(resource_name: str,
args: WorkloadArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Workload(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
lenses: Optional[Sequence[str]] = None,
environment: Optional[WorkloadEnvironment] = None,
industry: Optional[str] = None,
discovery_config: Optional[DiscoveryConfigPropertiesArgs] = None,
aws_regions: Optional[Sequence[str]] = None,
account_ids: Optional[Sequence[str]] = None,
industry_type: Optional[str] = None,
architectural_design: Optional[str] = None,
non_aws_regions: Optional[Sequence[str]] = None,
notes: Optional[str] = None,
review_owner: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
workload_name: Optional[str] = None)func NewWorkload(ctx *Context, name string, args WorkloadArgs, opts ...ResourceOption) (*Workload, error)public Workload(string name, WorkloadArgs args, CustomResourceOptions? opts = null)
public Workload(String name, WorkloadArgs args)
public Workload(String name, WorkloadArgs args, CustomResourceOptions options)
type: aws-native:wellarchitected:Workload
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_wellarchitected_workload" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args WorkloadArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkloadArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkloadArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkloadArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkloadArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Workload Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Workload resource accepts the following input properties:
- Description string
- The description for the workload.
- Environment
Pulumi.
Aws Native. Well Architected. Workload Environment - The environment for the workload.
- Lenses List<string>
- The list of lenses associated with the workload.
- Account
Ids List<string> - The list of Amazon Web Services account IDs associated with the workload.
- Architectural
Design string - The URL of the architectural design for the workload.
- Aws
Regions List<string> - The list of Amazon Web Services Regions associated with the workload.
- Discovery
Config Pulumi.Aws Native. Well Architected. Inputs. Discovery Config Properties - Discovery configuration associated to the workload.
- Industry string
- The industry for the workload.
- Industry
Type string - The industry type for the workload.
- Non
Aws List<string>Regions - The list of non-Amazon Web Services Regions associated with the workload.
- Notes string
- The notes associated with the workload.
- Review
Owner string - The review owner of the workload.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags associated with the workload.
- Workload
Name string - The name of the workload.
- Description string
- The description for the workload.
- Environment
Workload
Environment - The environment for the workload.
- Lenses []string
- The list of lenses associated with the workload.
- Account
Ids []string - The list of Amazon Web Services account IDs associated with the workload.
- Architectural
Design string - The URL of the architectural design for the workload.
- Aws
Regions []string - The list of Amazon Web Services Regions associated with the workload.
- Discovery
Config DiscoveryConfig Properties Args - Discovery configuration associated to the workload.
- Industry string
- The industry for the workload.
- Industry
Type string - The industry type for the workload.
- Non
Aws []stringRegions - The list of non-Amazon Web Services Regions associated with the workload.
- Notes string
- The notes associated with the workload.
- Review
Owner string - The review owner of the workload.
-
Tag
Args - The tags associated with the workload.
- Workload
Name string - The name of the workload.
- description string
- The description for the workload.
- environment "PRODUCTION" | "PREPRODUCTION"
- The environment for the workload.
- lenses list(string)
- The list of lenses associated with the workload.
- account_
ids list(string) - The list of Amazon Web Services account IDs associated with the workload.
- architectural_
design string - The URL of the architectural design for the workload.
- aws_
regions list(string) - The list of Amazon Web Services Regions associated with the workload.
- discovery_
config object - Discovery configuration associated to the workload.
- industry string
- The industry for the workload.
- industry_
type string - The industry type for the workload.
- non_
aws_ list(string)regions - The list of non-Amazon Web Services Regions associated with the workload.
- notes string
- The notes associated with the workload.
- review_
owner string - The review owner of the workload.
- list(object)
- The tags associated with the workload.
- workload_
name string - The name of the workload.
- description String
- The description for the workload.
- environment
Workload
Environment - The environment for the workload.
- lenses List<String>
- The list of lenses associated with the workload.
- account
Ids List<String> - The list of Amazon Web Services account IDs associated with the workload.
- architectural
Design String - The URL of the architectural design for the workload.
- aws
Regions List<String> - The list of Amazon Web Services Regions associated with the workload.
- discovery
Config DiscoveryConfig Properties - Discovery configuration associated to the workload.
- industry String
- The industry for the workload.
- industry
Type String - The industry type for the workload.
- non
Aws List<String>Regions - The list of non-Amazon Web Services Regions associated with the workload.
- notes String
- The notes associated with the workload.
- review
Owner String - The review owner of the workload.
- List<Tag>
- The tags associated with the workload.
- workload
Name String - The name of the workload.
- description string
- The description for the workload.
- environment
Workload
Environment - The environment for the workload.
- lenses string[]
- The list of lenses associated with the workload.
- account
Ids string[] - The list of Amazon Web Services account IDs associated with the workload.
- architectural
Design string - The URL of the architectural design for the workload.
- aws
Regions string[] - The list of Amazon Web Services Regions associated with the workload.
- discovery
Config DiscoveryConfig Properties - Discovery configuration associated to the workload.
- industry string
- The industry for the workload.
- industry
Type string - The industry type for the workload.
- non
Aws string[]Regions - The list of non-Amazon Web Services Regions associated with the workload.
- notes string
- The notes associated with the workload.
- review
Owner string - The review owner of the workload.
- Tag[]
- The tags associated with the workload.
- workload
Name string - The name of the workload.
- description str
- The description for the workload.
- environment
Workload
Environment - The environment for the workload.
- lenses Sequence[str]
- The list of lenses associated with the workload.
- account_
ids Sequence[str] - The list of Amazon Web Services account IDs associated with the workload.
- architectural_
design str - The URL of the architectural design for the workload.
- aws_
regions Sequence[str] - The list of Amazon Web Services Regions associated with the workload.
- discovery_
config DiscoveryConfig Properties Args - Discovery configuration associated to the workload.
- industry str
- The industry for the workload.
- industry_
type str - The industry type for the workload.
- non_
aws_ Sequence[str]regions - The list of non-Amazon Web Services Regions associated with the workload.
- notes str
- The notes associated with the workload.
- review_
owner str - The review owner of the workload.
-
Sequence[Tag
Args] - The tags associated with the workload.
- workload_
name str - The name of the workload.
- description String
- The description for the workload.
- environment "PRODUCTION" | "PREPRODUCTION"
- The environment for the workload.
- lenses List<String>
- The list of lenses associated with the workload.
- account
Ids List<String> - The list of Amazon Web Services account IDs associated with the workload.
- architectural
Design String - The URL of the architectural design for the workload.
- aws
Regions List<String> - The list of Amazon Web Services Regions associated with the workload.
- discovery
Config Property Map - Discovery configuration associated to the workload.
- industry String
- The industry for the workload.
- industry
Type String - The industry type for the workload.
- non
Aws List<String>Regions - The list of non-Amazon Web Services Regions associated with the workload.
- notes String
- The notes associated with the workload.
- review
Owner String - The review owner of the workload.
- List<Property Map>
- The tags associated with the workload.
- workload
Name String - The name of the workload.
Outputs
All input properties are implicitly available as output properties. Additionally, the Workload resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Improvement
Status Pulumi.Aws Native. Well Architected. Workload Improvement Status - The improvement status for a workload.
- Workload
Arn string - The ARN for the workload.
- Workload
Id string - The ID assigned to the workload.
- Id string
- The provider-assigned unique ID for this managed resource.
- Improvement
Status WorkloadImprovement Status - The improvement status for a workload.
- Workload
Arn string - The ARN for the workload.
- Workload
Id string - The ID assigned to the workload.
- id string
- The provider-assigned unique ID for this managed resource.
- improvement_
status "NOT_APPLICABLE" | "NOT_STARTED" | "IN_PROGRESS" | "COMPLETE" | "RISK_ACKNOWLEDGED" - The improvement status for a workload.
- workload_
arn string - The ARN for the workload.
- workload_
id string - The ID assigned to the workload.
- id String
- The provider-assigned unique ID for this managed resource.
- improvement
Status WorkloadImprovement Status - The improvement status for a workload.
- workload
Arn String - The ARN for the workload.
- workload
Id String - The ID assigned to the workload.
- id string
- The provider-assigned unique ID for this managed resource.
- improvement
Status WorkloadImprovement Status - The improvement status for a workload.
- workload
Arn string - The ARN for the workload.
- workload
Id string - The ID assigned to the workload.
- id str
- The provider-assigned unique ID for this managed resource.
- improvement_
status WorkloadImprovement Status - The improvement status for a workload.
- workload_
arn str - The ARN for the workload.
- workload_
id str - The ID assigned to the workload.
- id String
- The provider-assigned unique ID for this managed resource.
- improvement
Status "NOT_APPLICABLE" | "NOT_STARTED" | "IN_PROGRESS" | "COMPLETE" | "RISK_ACKNOWLEDGED" - The improvement status for a workload.
- workload
Arn String - The ARN for the workload.
- workload
Id String - The ID assigned to the workload.
Supporting Types
DiscoveryConfigProperties, DiscoveryConfigPropertiesArgs
Discovery configuration associated to the workload.- Trusted
Advisor Pulumi.Integration Status Aws Native. Well Architected. Workload Discovery Config Properties Trusted Advisor Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- Workload
Resource List<Pulumi.Definition Aws Native. Well Architected. Workload Discovery Config Properties Workload Resource Definition Item> - The mode to use for identifying resources associated with the workload.
- Trusted
Advisor WorkloadIntegration Status Discovery Config Properties Trusted Advisor Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- Workload
Resource []WorkloadDefinition Discovery Config Properties Workload Resource Definition Item - The mode to use for identifying resources associated with the workload.
- trusted_
advisor_ "ENABLED" | "DISABLED"integration_ status - Discovery integration status in respect to Trusted Advisor for the workload.
- workload_
resource_ list("WORKLOAD_METADATA" | "APP_REGISTRY")definition - The mode to use for identifying resources associated with the workload.
- trusted
Advisor WorkloadIntegration Status Discovery Config Properties Trusted Advisor Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- workload
Resource List<WorkloadDefinition Discovery Config Properties Workload Resource Definition Item> - The mode to use for identifying resources associated with the workload.
- trusted
Advisor WorkloadIntegration Status Discovery Config Properties Trusted Advisor Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- workload
Resource WorkloadDefinition Discovery Config Properties Workload Resource Definition Item[] - The mode to use for identifying resources associated with the workload.
- trusted_
advisor_ Workloadintegration_ status Discovery Config Properties Trusted Advisor Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- workload_
resource_ Sequence[Workloaddefinition Discovery Config Properties Workload Resource Definition Item] - The mode to use for identifying resources associated with the workload.
- trusted
Advisor "ENABLED" | "DISABLED"Integration Status - Discovery integration status in respect to Trusted Advisor for the workload.
- workload
Resource List<"WORKLOAD_METADATA" | "APP_REGISTRY">Definition - The mode to use for identifying resources associated with the workload.
Tag, TagArgs
A set of tags to apply to the resource.WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus, WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatusArgs
- Enabled
ENABLED- Disabled
DISABLED
- Workload
Discovery Config Properties Trusted Advisor Integration Status Enabled ENABLED- Workload
Discovery Config Properties Trusted Advisor Integration Status Disabled DISABLED
- "ENABLED"
ENABLED- "DISABLED"
DISABLED
- Enabled
ENABLED- Disabled
DISABLED
- Enabled
ENABLED- Disabled
DISABLED
- ENABLED
ENABLED- DISABLED
DISABLED
- "ENABLED"
ENABLED- "DISABLED"
DISABLED
WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem, WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItemArgs
- Workload
Metadata WORKLOAD_METADATA- App
Registry APP_REGISTRY
- Workload
Discovery Config Properties Workload Resource Definition Item Workload Metadata WORKLOAD_METADATA- Workload
Discovery Config Properties Workload Resource Definition Item App Registry APP_REGISTRY
- "WORKLOAD_METADATA"
WORKLOAD_METADATA- "APP_REGISTRY"
APP_REGISTRY
- Workload
Metadata WORKLOAD_METADATA- App
Registry APP_REGISTRY
- Workload
Metadata WORKLOAD_METADATA- App
Registry APP_REGISTRY
- WORKLOAD_METADATA
WORKLOAD_METADATA- APP_REGISTRY
APP_REGISTRY
- "WORKLOAD_METADATA"
WORKLOAD_METADATA- "APP_REGISTRY"
APP_REGISTRY
WorkloadEnvironment, WorkloadEnvironmentArgs
- Production
PRODUCTION- Preproduction
PREPRODUCTION
- Workload
Environment Production PRODUCTION- Workload
Environment Preproduction PREPRODUCTION
- "PRODUCTION"
PRODUCTION- "PREPRODUCTION"
PREPRODUCTION
- Production
PRODUCTION- Preproduction
PREPRODUCTION
- Production
PRODUCTION- Preproduction
PREPRODUCTION
- PRODUCTION
PRODUCTION- PREPRODUCTION
PREPRODUCTION
- "PRODUCTION"
PRODUCTION- "PREPRODUCTION"
PREPRODUCTION
WorkloadImprovementStatus, WorkloadImprovementStatusArgs
- Not
Applicable NOT_APPLICABLE- Not
Started NOT_STARTED- In
Progress IN_PROGRESS- Complete
COMPLETE- Risk
Acknowledged RISK_ACKNOWLEDGED
- Workload
Improvement Status Not Applicable NOT_APPLICABLE- Workload
Improvement Status Not Started NOT_STARTED- Workload
Improvement Status In Progress IN_PROGRESS- Workload
Improvement Status Complete COMPLETE- Workload
Improvement Status Risk Acknowledged RISK_ACKNOWLEDGED
- "NOT_APPLICABLE"
NOT_APPLICABLE- "NOT_STARTED"
NOT_STARTED- "IN_PROGRESS"
IN_PROGRESS- "COMPLETE"
COMPLETE- "RISK_ACKNOWLEDGED"
RISK_ACKNOWLEDGED
- Not
Applicable NOT_APPLICABLE- Not
Started NOT_STARTED- In
Progress IN_PROGRESS- Complete
COMPLETE- Risk
Acknowledged RISK_ACKNOWLEDGED
- Not
Applicable NOT_APPLICABLE- Not
Started NOT_STARTED- In
Progress IN_PROGRESS- Complete
COMPLETE- Risk
Acknowledged RISK_ACKNOWLEDGED
- NOT_APPLICABLE
NOT_APPLICABLE- NOT_STARTED
NOT_STARTED- IN_PROGRESS
IN_PROGRESS- COMPLETE
COMPLETE- RISK_ACKNOWLEDGED
RISK_ACKNOWLEDGED
- "NOT_APPLICABLE"
NOT_APPLICABLE- "NOT_STARTED"
NOT_STARTED- "IN_PROGRESS"
IN_PROGRESS- "COMPLETE"
COMPLETE- "RISK_ACKNOWLEDGED"
RISK_ACKNOWLEDGED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 21, 2026 by Pulumi