@cumulus/aws-client
Version:
Utilities for working with AWS
32 lines • 1.53 kB
TypeScript
/**
* @module CloudFormation
*/
/**
* Describes a given CloudFormation stack
*
* See [CloudFormation.Stack](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFormation.html#describeStacks-property)
*
* @param {string} StackName - The name of the CloudFormation stack to query
* @returns {Promise<CloudFormation.Stack>} The resources belonging to the stack
*/
export declare const describeCfStack: (StackName: string) => Promise<import("@aws-sdk/client-cloudformation").Stack>;
/**
* Describes the resources belonging to a given CloudFormation stack
*
* See [CloudFormation.StackResources](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFormation.html#describeStackResources-property)
*
* @param {string} StackName - The name of the CloudFormation stack to query
* @returns {Promise<CloudFormation.StackResources>} The resources belonging to the stack
*/
export declare const describeCfStackResources: (StackName: string) => Promise<import("@aws-sdk/client-cloudformation").StackResource[] | undefined>;
/**
* Get parameter values for the given CloudFormation stack
*
* @param {string} stackName - The name of the CloudFormation stack to query
* @param {Array<string>} parameterKeys - Key names for the stack parameters that you want to return
* @returns {Promise<Object>} Object keyed by parameter names
*/
export declare const getCfStackParameterValues: (stackName: string, parameterKeys: string[]) => Promise<{
[key: string]: string;
}>;
//# sourceMappingURL=CloudFormation.d.ts.map