aws-cdk-lib.cloud_assembly_schema.FileDestination

FileDestination Struct

Where in S3 a file asset needs to be published.

FileDestination

extends

• AwsDestination

Source

node_modules/@aws-cdk/cloud-assembly-schema/lib/assets/file-asset.d.ts

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

assumeRoleAdditionalOptions{ [key: string]: any }assume_role_additional_optionstyping.Mapping[str, Any]assumeRoleAdditionalOptionsMap<String, Object>AssumeRoleAdditionalOptionsIDictionary<string, object>AssumeRoleAdditionalOptions*map[string]interface{}#

Additional options to pass to STS when assuming the role.

Default: No additional options.

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

assumeRoleArnstringassume_role_arnstrassumeRoleArnStringAssumeRoleArnstringAssumeRoleArn*string#

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

Default: No role will be assumed

assumeRoleExternalIdstringassume_role_external_idstrassumeRoleExternalIdStringAssumeRoleExternalIdstringAssumeRoleExternalId*string#

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

Default: No ExternalId will be supplied

bucketNamestringbucket_namestrbucketNameStringBucketNamestringBucketName*stringrequired#

The name of the bucket.

objectKeystringobject_keystrobjectKeyStringObjectKeystringObjectKey*stringrequired#

The destination object key.

regionstringregionstrregionStringRegionstringRegion*string#

The region where this asset will need to be published.

Default: Current region