interface FileDestination

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.FileDestination
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#FileDestination
Java	software.amazon.awscdk.cloud_assembly_schema.FileDestination
Python	aws_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';

declare const assumeRoleAdditionalOptions: any;
const fileDestination: cloud_assembly_schema.FileDestination = {
  bucketName: 'bucketName',
  objectKey: 'objectKey',

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

Properties

Name	Type	Description
bucketName	string	The name of the bucket.
objectKey	string	The destination object key.
assumeRoleAdditionalOptions?	{ [string]: any }	Additional options to pass to STS when assuming the role.
assumeRoleArn?	string	The role that needs to be assumed while publishing this asset.
assumeRoleExternalId?	string	The ExternalId that needs to be supplied while assuming this role.
region?	string	The region where this asset will need to be published.

---

bucketName

Type: string

The name of the bucket.

---

objectKey

Type: string

The destination object key.

---

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the role.

• RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
• ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

---

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.