software.amazon.awscdk

Interface FileAssetLocation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileAssetLocation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.894Z")
 @Stability(value=Stable)
public interface FileAssetLocation
extends software.amazon.jsii.JsiiSerializable

The location of the published file asset.

This is where the asset can be consumed at runtime.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 FileAssetLocation fileAssetLocation = FileAssetLocation.builder()
         .bucketName("bucketName")
         .httpUrl("httpUrl")
         .objectKey("objectKey")
         .s3ObjectUrl("s3ObjectUrl")
         // the properties below are optional
         .kmsKeyArn("kmsKeyArn")
         .s3ObjectUrlWithPlaceholders("s3ObjectUrlWithPlaceholders")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileAssetLocation.Builder A builder for FileAssetLocation
static class	FileAssetLocation.Jsii$Proxy An implementation for FileAssetLocation

Method Summary

Modifier and Type	Method and Description
static FileAssetLocation.Builder	builder()
String	getBucketName() The name of the Amazon S3 bucket.
String	getHttpUrl() The HTTP URL of this asset on Amazon S3.
default String	getKmsKeyArn() The ARN of the KMS key used to encrypt the file asset bucket, if any.
String	getObjectKey() The Amazon S3 object key.
String	getS3ObjectUrl() The S3 URL of this asset on Amazon S3.
default String	getS3ObjectUrlWithPlaceholders() Like `s3ObjectUrl`, but not suitable for CloudFormation consumption.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucketName

@Stability(value=Stable)
 @NotNull
String getBucketName()

The name of the Amazon S3 bucket.

getHttpUrl

@Stability(value=Stable)
 @NotNull
String getHttpUrl()

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

getObjectKey

@Stability(value=Stable)
 @NotNull
String getObjectKey()

The Amazon S3 object key.

getS3ObjectUrl

@Stability(value=Stable)
 @NotNull
String getS3ObjectUrl()

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

getKmsKeyArn

@Stability(value=Stable)
 @Nullable
default String getKmsKeyArn()

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

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.

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

getS3ObjectUrlWithPlaceholders

@Stability(value=Stable)
 @Nullable
default String getS3ObjectUrlWithPlaceholders()

Like `s3ObjectUrl`, but not suitable for CloudFormation consumption.

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

Default: - This feature cannot be used

builder

@Stability(value=Stable)
static FileAssetLocation.Builder builder()

Returns:

a FileAssetLocation.Builder of FileAssetLocation