@aws-cdk_app-staging-synthesizer-alpha.FileStagingLocation

interface FileStagingLocation ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AppStagingSynthesizer.Alpha.FileStagingLocation
Javasoftware.amazon.awscdk.app.staging.synthesizer.alpha.FileStagingLocation
Pythonaws_cdk.app_staging_synthesizer_alpha.FileStagingLocation
TypeScript (source)@aws-cdk/app-staging-synthesizer-alpha ยป FileStagingLocation

Obtainable from DefaultStagingStack.addFile()

Information returned by the Staging Stack for each file asset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as app_staging_synthesizer_alpha from '@aws-cdk/app-staging-synthesizer-alpha';
import * as cdk from 'aws-cdk-lib';

declare const stack: cdk.Stack;
const fileStagingLocation: app_staging_synthesizer_alpha.FileStagingLocation = {
  bucketName: 'bucketName',

  // the properties below are optional
  assumeRoleArn: 'assumeRoleArn',
  dependencyStack: stack,
  prefix: 'prefix',
};

Properties

NameTypeDescription
bucketName๐Ÿ”นstringThe name of the staging bucket.
assumeRoleArn?๐Ÿ”นstringThe ARN to assume to write files to this bucket.
dependencyStack?๐Ÿ”นStackThe stack that creates this bucket (leads to dependencies on it).
prefix?๐Ÿ”นstringA prefix to add to the keys.

bucketName๐Ÿ”น

Type: string

The name of the staging bucket.


assumeRoleArn?๐Ÿ”น

Type: string (optional, default: Don't assume a role)

The ARN to assume to write files to this bucket.


dependencyStack?๐Ÿ”น

Type: Stack (optional, default: Don't add dependencies)

The stack that creates this bucket (leads to dependencies on it).


prefix?๐Ÿ”น

Type: string (optional, default: '')

A prefix to add to the keys.