workload_deployment_patterns

Creates, updates, deletes, gets or lists a workload_deployment_patterns resource.

Overview

Name	workload_deployment_patterns
Type	Resource
Id	aws.launch_wizard.workload_deployment_patterns

Fields

The following fields are returned by SELECT queries:

get_workload_deployment_pattern

Name	Datatype	Description
deployment_pattern_name	string	The name of the deployment pattern. (pattern: <code>[A-Za-z0-9][a-zA-Z0-9-]*</code>)
deployment_pattern_version_name	string	The version name of the deployment pattern. (pattern: <code>(([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+.\d+.\d+))</code>)
description	string	The description of the deployment pattern.
display_name	string	The display name of the deployment pattern.
specifications	array	The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
status	string	The status of the deployment pattern. (ACTIVE, INACTIVE, DISABLED, DELETED)
status_message	string	The status message of the deployment pattern.
workload_name	string	The workload name of the deployment pattern. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)
workload_version_name	string	The workload version name of the deployment pattern. (pattern: <code>(([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+.\d+.\d+))</code>)

list_workload_deployment_patterns

Name	Datatype	Description
deployment_pattern_name	string	The name of a workload deployment pattern. (pattern: <code>[A-Za-z0-9][a-zA-Z0-9-]*</code>)
deployment_pattern_version_name	string	The version name of a workload deployment pattern. (pattern: <code>(([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+.\d+.\d+))</code>)
description	string	The description of a workload deployment pattern.
display_name	string	The display name of a workload deployment pattern.
status	string	The status of a workload deployment pattern. (ACTIVE, INACTIVE, DISABLED, DELETED)
status_message	string	A message about a workload deployment pattern's status.
workload_name	string	The name of the workload. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)
workload_version_name	string	The name of the workload deployment pattern version. (pattern: <code>(([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+.\d+.\d+))</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workload_deployment_pattern	select	region		Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.
list_workload_deployment_patterns	select	region		Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_workload_deployment_pattern

Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.

SELECT
deployment_pattern_name,
deployment_pattern_version_name,
description,
display_name,
specifications,
status,
status_message,
workload_name,
workload_version_name
FROM aws.launch_wizard.workload_deployment_patterns
WHERE region = '{{ region }}' -- required
;

list_workload_deployment_patterns

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

SELECT
deployment_pattern_name,
deployment_pattern_version_name,
description,
display_name,
status,
status_message,
workload_name,
workload_version_name
FROM aws.launch_wizard.workload_deployment_patterns
WHERE region = '{{ region }}' -- required
;