Package software.amazon.awscdk.core

Interface FileAssetLocation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileAssetLocation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.036Z")
@Stability(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.core.*;
 FileAssetLocation fileAssetLocation = FileAssetLocation.builder()
         .bucketName("bucketName")
         .httpUrl("httpUrl")
         .objectKey("objectKey")
         .s3ObjectUrl("s3ObjectUrl")
         // the properties below are optional
         .kmsKeyArn("kmsKeyArn")
         .s3ObjectUrlWithPlaceholders("s3ObjectUrlWithPlaceholders")
         .s3Url("s3Url")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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.
default String	getS3Url()	Deprecated. use httpUrl

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

The name of the Amazon S3 bucket.

getHttpUrl

@Stability(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(Stable)
@NotNull
String getObjectKey()

The Amazon S3 object key.

getS3ObjectUrl

@Stability(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(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(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

getS3Url

@Stability(Deprecated)
@Deprecated
@Nullable
default String getS3Url()

Deprecated.

use httpUrl

(deprecated) The HTTP URL of this asset on Amazon S3.

Default: - value specified in `httpUrl` is used.

builder

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

Returns:

a FileAssetLocation.Builder of FileAssetLocation