software.amazon.awscdk.core

Interface FileAssetLocation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileAssetLocation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.9.0 (build 5c646d5)",
           date="2020-08-14T23:35:53.719Z")
 @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.

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.
String	getS3Url() Deprecated. use `httpUrl`

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.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 https:

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.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 s3:

getS3Url

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getS3Url()

Deprecated. use `httpUrl`

The HTTP URL of this asset on Amazon S3.

getKmsKeyArn

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

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

If so, the consuming role should be given "kms:Decrypt" permissions in its identity policy.

It's the responsibility of they key's creator to make sure that all consumers that the key's key policy is configured such that the key can be used by all consumers that need it.

The default bootstrap stack provisioned by the CDK CLI ensures this, and can be used as an example for how to configure the key properly.

Default: - Asset bucket is not encrypted

builder

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

Returns:

a FileAssetLocation.Builder of FileAssetLocation