@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
118 lines (117 loc) • 5.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for Greengrass V2 deployment.
*/
export declare class Deployment extends pulumi.CustomResource {
/**
* Get an existing Deployment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Deployment;
/**
* Returns true if the given object is an instance of Deployment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Deployment;
/**
* The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
*/
readonly components: pulumi.Output<{
[key: string]: outputs.greengrassv2.DeploymentComponentDeploymentSpecification;
} | undefined>;
/**
* The ID of the deployment.
*/
readonly deploymentId: pulumi.Output<string>;
/**
* The name of the deployment.
*/
readonly deploymentName: pulumi.Output<string | undefined>;
/**
* The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
*/
readonly deploymentPolicies: pulumi.Output<outputs.greengrassv2.DeploymentPolicies | undefined>;
/**
* The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
*/
readonly iotJobConfiguration: pulumi.Output<outputs.greengrassv2.DeploymentIoTJobConfiguration | undefined>;
/**
* The parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment.
*/
readonly parentTargetArn: pulumi.Output<string | undefined>;
/**
* Application-specific metadata to attach to the deployment. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```json
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The ARN of the target AWS IoT thing or thing group.
*/
readonly targetArn: pulumi.Output<string>;
/**
* Create a Deployment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Deployment resource.
*/
export interface DeploymentArgs {
/**
* The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
*/
components?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.greengrassv2.DeploymentComponentDeploymentSpecificationArgs>;
}>;
/**
* The name of the deployment.
*/
deploymentName?: pulumi.Input<string>;
/**
* The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
*/
deploymentPolicies?: pulumi.Input<inputs.greengrassv2.DeploymentPoliciesArgs>;
/**
* The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
*/
iotJobConfiguration?: pulumi.Input<inputs.greengrassv2.DeploymentIoTJobConfigurationArgs>;
/**
* The parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment.
*/
parentTargetArn?: pulumi.Input<string>;
/**
* Application-specific metadata to attach to the deployment. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```json
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The ARN of the target AWS IoT thing or thing group.
*/
targetArn: pulumi.Input<string>;
}