/*WRITE ONLY BELOW THIS LINE*/ /*WRITE ONLY ABOVE THIS LINE*/ "use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { code: "code", h1: "h1", h3: "h3", p: "p", pre: "pre", ..._provideComponents(), ...props.components }, {SdkMethodsApiReference} = _components; if (!SdkMethodsApiReference) _missingMdxReference("SdkMethodsApiReference", true); return _jsxs(_Fragment, { children: [_jsx(_components.h1, { id: "overview-and-basic-usage", children: "Overview and basic usage" }), "\n", _jsx("br", {}), "\n", _jsx(_components.h3, { id: "preview-changes", children: "preview-changes" }), "\n", _jsx(_components.p, { children: "Shows a preview of the changes that will be made to your stack if you deploy the current configuration." }), "\n", _jsx("br", {}), "\n", _jsx("br", {}), "\n", "\n", "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-typescript", children: "import { Stacktape } from \"stacktape\";\n\nconst stacktape = new Stacktape();\n\nstacktape.previewChanges({\n region: \"<>\",\n stage: \"<>\"\n});\n" }) }), "\n", _jsx(_components.h1, { id: "api-reference", children: "API reference" }), "\n", _jsx(SdkMethodsApiReference, { command: "preview-changes", sortedArgs: [{ description: "#### AWS Region\n\n---\n\nThe AWS region for the operation. For a list of available regions, see the [AWS documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html).", allowedTypes: ["string"], allowedValues: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2"], required: true, name: "region", shortDescription: "

AWS Region

\n", longDescription: '

The AWS region for the operation. For a list of available regions, see the AWS documentation.

\n' }, { description: "#### Stage\n\n---\n\nThe stage for the operation (e.g., `production`, `staging`, `dev-john`). You can set a default stage using the `defaults:configure` command. The maximum length is 12 characters.", allowedTypes: ["string"], required: true, name: "stage", shortDescription: "

Stage

\n", longDescription: "

The stage for the operation (e.g., production, staging, dev-john). You can set a default stage using the defaults:configure command. The maximum length is 12 characters.

\n" }, { description: "#### AWS Account\n\n---\n\nThe name of the AWS account to use for the operation. The account must first be connected in the [Stacktape console](https://console.stacktape.com/aws-accounts).", allowedTypes: ["string"], required: false, name: "awsAccount", shortDescription: "

AWS Account

\n", longDescription: '

The name of the AWS account to use for the operation. The account must first be connected in the Stacktape console.

\n' }, { description: "#### Directly supplied stacktape configuration object", allowedTypes: ["object"], required: false, name: "config", shortDescription: "

Directly supplied stacktape configuration object

\n" }, { description: "#### Config File Path\n\n---\n\nThe path to your Stacktape configuration file, relative to the current working directory.", allowedTypes: ["string"], required: false, name: "configPath", shortDescription: "

Config File Path

\n", longDescription: "

The path to your Stacktape configuration file, relative to the current working directory.

\n" }, { description: "#### Current Working Directory\n\n---\n\nThe working directory for the operation. All file paths in your configuration will be resolved relative to this directory. By default, this is the directory containing the configuration file.", allowedTypes: ["string"], required: false, name: "currentWorkingDirectory", shortDescription: "

Current Working Directory

\n", longDescription: "

The working directory for the operation. All file paths in your configuration will be resolved relative to this directory. By default, this is the directory containing the configuration file.

\n" }, { description: "#### Preserve Temporary Files\n\n---\n\nIf `true`, preserves the temporary files generated by the operation, such as the CloudFormation template and packaged resources. These files are saved to `.stacktape/[invocation-id]`.", allowedTypes: ["boolean"], required: false, name: "preserveTempFiles", shortDescription: "

Preserve Temporary Files

\n", longDescription: "

If true, preserves the temporary files generated by the operation, such as the CloudFormation template and packaged resources. These files are saved to .stacktape/[invocation-id].

\n" }, { description: "#### AWS Profile\n\n---\n\nThe AWS profile to use for the command. You can manage profiles using the `aws-profile:*` commands and set a default profile with `defaults:configure`.", allowedTypes: ["string"], required: false, name: "profile", shortDescription: "

AWS Profile

\n", longDescription: "

The AWS profile to use for the command. You can manage profiles using the aws-profile:* commands and set a default profile with defaults:configure.

\n" }, { description: "#### Project Name\n\n---\n\nThe name of the Stacktape project for this operation.", allowedTypes: ["string"], required: false, name: "projectName", shortDescription: "

Project Name

\n", longDescription: "

The name of the Stacktape project for this operation.

\n" }, { description: "#### Template ID\n\n---\n\nThe ID of the template to download. You can find a list of available templates on the [Config Builder page](https://console.stacktape.com/templates).", allowedTypes: ["string"], required: false, name: "templateId", shortDescription: "

Template ID

\n", longDescription: '

The ID of the template to download. You can find a list of available templates on the Config Builder page.

\n' }] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

previewChanges()

Overview and basic usage

preview-changes

API reference