aws-cdk-lib.cloud_assembly_schema.FileDestination

interface FileDestination

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.FileDestination
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#FileDestination
Javasoftware.amazon.awscdk.cloudassembly.schema.FileDestination
Pythonaws_cdk.cloud_assembly_schema.FileDestination
TypeScript (source)aws-cdk-lib » cloud_assembly_schema » FileDestination

Obtainable from AssetManifestBuilder.addFileAsset(), AssetManifestBuilder.defaultAddFileAsset()

Where in S3 a file asset needs to be published.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const fileDestination: cloud_assembly_schema.FileDestination = {
  bucketName: 'bucketName',
  objectKey: 'objectKey',

  // the properties below are optional
  assumeRoleArn: 'assumeRoleArn',
  assumeRoleExternalId: 'assumeRoleExternalId',
  region: 'region',
};

Properties

NameTypeDescription
bucketNamestringThe name of the bucket.
objectKeystringThe destination object key.
assumeRoleArn?stringThe role that needs to be assumed while publishing this asset.
assumeRoleExternalId?stringThe ExternalId that needs to be supplied while assuming this role.
region?stringThe region where this asset will need to be published.

bucketName

Type: string

The name of the bucket.


objectKey

Type: string

The destination object key.


assumeRoleArn?

Type: string (optional, default: No role will be assumed)

The role that needs to be assumed while publishing this asset.


assumeRoleExternalId?

Type: string (optional, default: No ExternalId will be supplied)

The ExternalId that needs to be supplied while assuming this role.


region?

Type: string (optional, default: Current region)

The region where this asset will need to be published.