# StackDeploymentProps

Properties for a `StackDeployment`.

- Source: [`pipelines/lib/blueprint/stack-deployment.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/pipelines/lib/blueprint/stack-deployment.ts#L13)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { pipelines } from 'aws-cdk-lib';
const stackDeploymentProps: pipelines.StackDeploymentProps = {
  absoluteTemplatePath: 'absoluteTemplatePath',
  constructPath: 'constructPath',
  stackArtifactId: 'stackArtifactId',
  stackName: 'stackName',

  // the properties below are optional
  account: 'account',
  assets: [{
    assetId: 'assetId',
    assetManifestPath: 'assetManifestPath',
    assetSelector: 'assetSelector',
    assetType: pipelines.AssetType.FILE,
    isTemplate: false,

    // the properties below are optional
    assetPublishingRoleArn: 'assetPublishingRoleArn',
    displayName: 'displayName',
  }],
  assumeRoleArn: 'assumeRoleArn',
  executionRoleArn: 'executionRoleArn',
  region: 'region',
  tags: {
    tagsKey: 'tags',
  },
  templateS3Uri: 'templateS3Uri',
};
```

## Properties

- `absoluteTemplatePath`: string (required) — Template path on disk to cloud assembly (cdk.out).

- `account`: string — Account where the stack should be deployed.

  **Default:** Pipeline account

- `assets`: [StackAsset](/cdk/api/v2/docs/aws-cdk-lib.pipelines.StackAsset.html)[] — Assets referenced by this stack.

  **Default:** No assets

- `assumeRoleArn`: string — Role to assume before deploying this stack.

  **Default:** Don't assume any role

- `constructPath`: string (required) — Construct path for this stack.

- `executionRoleArn`: string — Execution role to pass to CloudFormation.

  **Default:** No execution role

- `region`: string — Region where the stack should be deployed.

  **Default:** Pipeline region

- `stackArtifactId`: string (required) — Artifact ID for this stack.

- `stackName`: string (required) — Name for this stack.

- `tags`: { [key: string]: string } — Tags to apply to the stack.

  **Default:** No tags

- `templateS3Uri`: string — The S3 URL which points to the template asset location in the publishing bucket.

  **Default:** Stack template is not published