AWS CDK

2.268.0

interface CfnWorkloadProps

Language	Type name
.NET	`Amazon.CDK.AWS.WellArchitected.CfnWorkloadProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswellarchitected#CfnWorkloadProps`
Java	`software.amazon.awscdk.services.wellarchitected.CfnWorkloadProps`
Python	`aws_cdk.aws_wellarchitected.CfnWorkloadProps`
TypeScript	`aws-cdk-lib` » `aws_wellarchitected` » `CfnWorkloadProps`

Properties for defining a CfnWorkload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html

Example

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

Name	Type	Description
description	`string`	The description for the workload.
environment	`string`	The environment for the workload.
lenses	`string[]`	The list of lenses associated with the workload.
workloadName	`string`	The name of the workload.
accountIds?	`string[]`	The list of Amazon Web Services account IDs associated with the workload.
architecturalDesign?	`string`	The URL of the architectural design for the workload.
awsRegions?	`string[]`	The list of Amazon Web Services Regions associated with the workload.
discoveryConfig?	`IResolvable` `\|` `DiscoveryConfigProperty`	Discovery configuration associated to the workload.
industry?	`string`	The industry for the workload.
industryType?	`string`	The industry type for the workload.
nonAwsRegions?	`string[]`	The list of non-Amazon Web Services Regions associated with the workload.
notes?	`string`	The notes associated with the workload.
reviewOwner?	`string`	The review owner of the workload.
tags?	`TagsItemsProperty[]`	The tags associated with the workload.

description

Type: string

The description for the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-description

environment

Type: string

The environment for the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-environment

lenses

Type: string[]

The list of lenses associated with the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-lenses

workloadName

Type: string

The name of the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-workloadname

accountIds?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-accountids

architecturalDesign?

Type: string (optional)

The URL of the architectural design for the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-architecturaldesign

awsRegions?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-awsregions

discoveryConfig?

Type: IResolvable | DiscoveryConfigProperty (optional)

Discovery configuration associated to the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-discoveryconfig

industry?

Type: string (optional)

The industry for the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-industry

industryType?

Type: string (optional)

The industry type for the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-industrytype

nonAwsRegions?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-nonawsregions

notes?

Type: string (optional)

The notes associated with the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-notes

reviewOwner?

Type: string (optional)

The review owner of the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-reviewowner

tags?

Type: TagsItemsProperty[] (optional)

The tags associated with the workload.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-workload.html#cfn-wellarchitected-workload-tags

← Previous Next →