Skip to content

Create Workload

wellarchitected_create_workload R Documentation

Create a new workload

Description

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

When creating a workload using a review template, you must have the following IAM permissions:

  • wellarchitected:GetReviewTemplate

  • wellarchitected:GetReviewTemplateAnswer

  • wellarchitected:ListReviewTemplateAnswers

  • wellarchitected:GetReviewTemplateLensReview

Usage

wellarchitected_create_workload(WorkloadName, Description, Environment,
  AccountIds, AwsRegions, NonAwsRegions, PillarPriorities,
  ArchitecturalDesign, ReviewOwner, IndustryType, Industry, Lenses, Notes,
  ClientRequestToken, Tags, DiscoveryConfig, Applications, ProfileArns,
  ReviewTemplateArns, JiraConfiguration)

Arguments

WorkloadName

[required]

Description

[required]

Environment

[required]

AccountIds
AwsRegions
NonAwsRegions
PillarPriorities
ArchitecturalDesign
ReviewOwner
IndustryType
Industry
Lenses

[required]

Notes
ClientRequestToken

[required]

Tags

The tags to be associated with the workload.

DiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.

Applications

List of AppRegistry application ARNs associated to the workload.

ProfileArns

The list of profile ARNs associated with the workload.

ReviewTemplateArns

The list of review template ARNs to associate with the workload.

JiraConfiguration

Jira configuration settings when creating a workload.

Value

A list with the following syntax: 

list(
  WorkloadId = "string",
  WorkloadArn = "string"
)

Request syntax

svc$create_workload(
  WorkloadName = "string",
  Description = "string",
  Environment = "PRODUCTION"|"PREPRODUCTION",
  AccountIds = list(
    "string"
  ),
  AwsRegions = list(
    "string"
  ),
  NonAwsRegions = list(
    "string"
  ),
  PillarPriorities = list(
    "string"
  ),
  ArchitecturalDesign = "string",
  ReviewOwner = "string",
  IndustryType = "string",
  Industry = "string",
  Lenses = list(
    "string"
  ),
  Notes = "string",
  ClientRequestToken = "string",
  Tags = list(
    "string"
  ),
  DiscoveryConfig = list(
    TrustedAdvisorIntegrationStatus = "ENABLED"|"DISABLED",
    WorkloadResourceDefinition = list(
      "WORKLOAD_METADATA"|"APP_REGISTRY"
    )
  ),
  Applications = list(
    "string"
  ),
  ProfileArns = list(
    "string"
  ),
  ReviewTemplateArns = list(
    "string"
  ),
  JiraConfiguration = list(
    IssueManagementStatus = "ENABLED"|"DISABLED"|"INHERIT",
    IssueManagementType = "AUTO"|"MANUAL",
    JiraProjectKey = "string"
  )
)