AWS CDK Reference

Appearance

v2.274.0

CfnWorkloadProps Struct ​

Properties for defining a CfnWorkload.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wellarchitected as wellarchitected } from 'aws-cdk-lib';
const cfnWorkloadProps: wellarchitected.CfnWorkloadProps = {
  description: 'description',
  environment: 'environment',
  lenses: ['lenses'],
  workloadName: 'workloadName',

  // the properties below are optional
  accountIds: ['accountIds'],
  architecturalDesign: 'architecturalDesign',
  awsRegions: ['awsRegions'],
  discoveryConfig: {
    trustedAdvisorIntegrationStatus: 'trustedAdvisorIntegrationStatus',
    workloadResourceDefinition: ['workloadResourceDefinition'],
  },
  industry: 'industry',
  industryType: 'industryType',
  nonAwsRegions: ['nonAwsRegions'],
  notes: 'notes',
  reviewOwner: 'reviewOwner',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

accountIdsoptionalstring[]account_idsoptionaltyping.List[str]accountIdsoptionalList<String>AccountIdsoptionalstring[]AccountIdsoptional*[]*string#
The list of Amazon Web Services account IDs associated with the workload.
architecturalDesignoptionalstringarchitectural_designoptionalstrarchitecturalDesignoptionalStringArchitecturalDesignoptionalstringArchitecturalDesignoptional*string#
The URL of the architectural design for the workload.
awsRegionsoptionalstring[]aws_regionsoptionaltyping.List[str]awsRegionsoptionalList<String>AwsRegionsoptionalstring[]AwsRegionsoptional*[]*string#
The list of Amazon Web Services Regions associated with the workload.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#
The description for the workload.
discoveryConfigoptionalIResolvable | CfnWorkload.DiscoveryConfigPropertydiscovery_configoptionaltyping.Union[IResolvable, DiscoveryConfigProperty]discoveryConfigoptionalIResolvableDiscoveryConfigoptionalIResolvableDiscoveryConfigoptionalinterface{}#
Discovery configuration associated to the workload.
environmentstringenvironmentstrenvironmentStringEnvironmentstringEnvironment*stringrequired#
The environment for the workload.
industryoptionalstringindustryoptionalstrindustryoptionalStringIndustryoptionalstringIndustryoptional*string#
The industry for the workload.
industryTypeoptionalstringindustry_typeoptionalstrindustryTypeoptionalStringIndustryTypeoptionalstringIndustryTypeoptional*string#
The industry type for the workload.
lensesstring[]lensestyping.List[str]lensesList<String>Lensesstring[]Lenses*[]*stringrequired#
The list of lenses associated with the workload.
nonAwsRegionsoptionalstring[]non_aws_regionsoptionaltyping.List[str]nonAwsRegionsoptionalList<String>NonAwsRegionsoptionalstring[]NonAwsRegionsoptional*[]*string#
The list of non-Amazon Web Services Regions associated with the workload.
notesoptionalstringnotesoptionalstrnotesoptionalStringNotesoptionalstringNotesoptional*string#
The notes associated with the workload.
reviewOwneroptionalstringreview_owneroptionalstrreviewOwneroptionalStringReviewOwneroptionalstringReviewOwneroptional*string#
The review owner of the workload.
tagsoptionalCfnWorkload.TagsItemsProperty[]tagsoptionaltyping.List[TagsItemsProperty]tagsoptionalList<TagsItemsProperty>TagsoptionalTagsItemsProperty[]Tagsoptional*[]TagsItemsProperty#
The tags associated with the workload.
workloadNamestringworkload_namestrworkloadNameStringWorkloadNamestringWorkloadName*stringrequired#
The name of the workload.