aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
144 lines (143 loc) • 5.48 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* Creates a deployment for the given workload.
*
* Deployments created by this operation are not available in the Launch Wizard console to use the `Clone deployment` action on.
*
* @cloudformationResource AWS::LaunchWizard::Deployment
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html
*/
export declare class CfnDeployment extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDeployment from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDeployment;
/**
* The Amazon Resource Name (ARN) of the deployment.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The time the deployment was created.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* The time the deployment was deleted.
*
* @cloudformationAttribute DeletedAt
*/
readonly attrDeletedAt: string;
/**
* The ID of the deployment.
*
* @cloudformationAttribute DeploymentId
*/
readonly attrDeploymentId: string;
/**
* The resource group of the deployment.
*
* @cloudformationAttribute ResourceGroup
*/
readonly attrResourceGroup: string;
/**
* The status of the deployment.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The name of the deployment pattern.
*/
deploymentPatternName: string;
/**
* The name of the deployment.
*/
name: string;
/**
* The settings specified for the deployment.
*/
specifications?: cdk.IResolvable | Record<string, string>;
/**
* Information about the tags attached to a deployment.
*/
tags?: Array<cdk.CfnTag>;
/**
* The name of the workload.
*/
workloadName: string;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnDeploymentProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnDeployment`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html
*/
export interface CfnDeploymentProps {
/**
* The name of the deployment pattern.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-deploymentpatternname
*/
readonly deploymentPatternName: string;
/**
* The name of the deployment.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-name
*/
readonly name: string;
/**
* 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](https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html) . To retrieve the specifications required to create a deployment for other workloads, use the [`GetWorkloadDeploymentPattern`](https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html) operation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-specifications
*/
readonly specifications?: cdk.IResolvable | Record<string, string>;
/**
* Information about the tags attached to a deployment.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The name of the workload.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-workloadname
*/
readonly workloadName: string;
}