CfnWorkloadProps

class aws_cdk.aws_wellarchitected.CfnWorkloadProps(*, description, environment, lenses, workload_name, account_ids=None, architectural_design=None, aws_regions=None, discovery_config=None, industry=None, industry_type=None, non_aws_regions=None, notes=None, review_owner=None, tags=None)

Bases: object

Properties for defining a CfnWorkload.

Parameters:
  • description (str) – The description for the workload.

  • environment (str) – The environment for the workload.

  • lenses (Sequence[str]) – The list of lenses associated with the workload.

  • workload_name (str) – The name of the workload.

  • account_ids (Optional[Sequence[str]]) – The list of Amazon Web Services account IDs associated with the workload.

  • architectural_design (Optional[str]) – The URL of the architectural design for the workload.

  • aws_regions (Optional[Sequence[str]]) – The list of Amazon Web Services Regions associated with the workload.

  • discovery_config (Union[IResolvable, DiscoveryConfigProperty, Dict[str, Any], None]) – Discovery configuration associated to the workload.

  • industry (Optional[str]) – The industry for the workload.

  • industry_type (Optional[str]) – The industry type for the workload.

  • non_aws_regions (Optional[Sequence[str]]) – The list of non-Amazon Web Services Regions associated with the workload.

  • notes (Optional[str]) – The notes associated with the workload.

  • review_owner (Optional[str]) – The review owner of the workload.

  • tags (Optional[Sequence[Union[TagsItemsProperty, Dict[str, Any]]]]) – The tags associated with the workload.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wellarchitected as wellarchitected

cfn_workload_props = wellarchitected.CfnWorkloadProps(
    description="description",
    environment="environment",
    lenses=["lenses"],
    workload_name="workloadName",

    # the properties below are optional
    account_ids=["accountIds"],
    architectural_design="architecturalDesign",
    aws_regions=["awsRegions"],
    discovery_config=wellarchitected.CfnWorkload.DiscoveryConfigProperty(
        trusted_advisor_integration_status="trustedAdvisorIntegrationStatus",
        workload_resource_definition=["workloadResourceDefinition"]
    ),
    industry="industry",
    industry_type="industryType",
    non_aws_regions=["nonAwsRegions"],
    notes="notes",
    review_owner="reviewOwner",
    tags=[wellarchitected.CfnWorkload.TagsItemsProperty(
        key="key",
        value="value"
    )]
)

Attributes

account_ids

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

See:

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

architectural_design

The URL of the architectural design for the workload.

See:

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

aws_regions

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

See:

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

description

The description for the workload.

See:

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

discovery_config

Discovery configuration associated to the workload.

See:

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

environment

The environment for the workload.

See:

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

industry

The industry for the workload.

See:

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

industry_type

The industry type for the workload.

See:

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

lenses

The list of lenses associated with the workload.

See:

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

non_aws_regions

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

See:

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

notes

The notes associated with the workload.

See:

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

review_owner

The review owner of the workload.

See:

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

tags

The tags associated with the workload.

See:

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

workload_name

The name of the workload.

See:

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