AWS CDK Reference

Appearance

v2.274.0

FileAssetLocation Struct ​

The location of the published file asset.

This is where the asset can be consumed at runtime.

Source
core/lib/assets.ts
Type last changed
v2.21.0 · 22 Apr 2022

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const fileAssetLocation: cdk.FileAssetLocation = {
  bucketName: 'bucketName',
  httpUrl: 'httpUrl',
  objectKey: 'objectKey',
  s3ObjectUrl: 's3ObjectUrl',

  // the properties below are optional
  kmsKeyArn: 'kmsKeyArn',
  s3ObjectUrlWithPlaceholders: 's3ObjectUrlWithPlaceholders',
};

Properties ​

bucketNamestringbucket_namestrbucketNameStringBucketNamestringBucketName*stringrequired#
The name of the Amazon S3 bucket.
httpUrlstringhttp_urlstrhttpUrlStringHttpUrlstringHttpUrl*stringrequired#
The HTTP URL of this asset on Amazon S3.

This value suitable for inclusion in a CloudFormation template, and may be an encoded token.

Example value: https://s3-us-east-1.amazonaws.com/mybucket/myobject

kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#
The ARN of the KMS key used to encrypt the file asset bucket, if any.

Default: Asset bucket is not encrypted, or decryption permissions are defined by a Key Policy.

The CDK bootstrap stack comes with a key policy that does not require setting this property, so you only need to set this property if you have customized the bootstrap stack to require it.

objectKeystringobject_keystrobjectKeyStringObjectKeystringObjectKey*stringrequired#
The Amazon S3 object key.
s3ObjectUrlstrings3_object_urlstrs3ObjectUrlStringS3ObjectUrlstringS3ObjectUrl*stringrequired#
The S3 URL of this asset on Amazon S3.

This value suitable for inclusion in a CloudFormation template, and may be an encoded token.

Example value: s3://mybucket/myobject

s3ObjectUrlWithPlaceholdersoptionalstrings3_object_url_with_placeholdersoptionalstrs3ObjectUrlWithPlaceholdersoptionalStringS3ObjectUrlWithPlaceholdersoptionalstringS3ObjectUrlWithPlaceholdersoptional*string#
Like `s3ObjectUrl`, but not suitable for CloudFormation consumption.

Default: This feature cannot be used

If there are placeholders in the S3 URL, they will be returned un-replaced and un-evaluated.