Interface FileAssetLocation
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
FileAssetLocation.Jsii$Proxy
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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forFileAssetLocation
static final class
An implementation forFileAssetLocation
-
Method Summary
Modifier and TypeMethodDescriptionstatic FileAssetLocation.Builder
builder()
The name of the Amazon S3 bucket.The HTTP URL of this asset on Amazon S3.default String
The ARN of the KMS key used to encrypt the file asset bucket, if any.The Amazon S3 object key.The S3 URL of this asset on Amazon S3.default String
Likes3ObjectUrl
, but not suitable for CloudFormation consumption.default String
getS3Url()
Deprecated.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBucketName
The name of the Amazon S3 bucket. -
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
The Amazon S3 object key. -
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
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
Likes3ObjectUrl
, 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
Deprecated.usehttpUrl
(deprecated) The HTTP URL of this asset on Amazon S3.Default: - value specified in `httpUrl` is used.
-
builder
- Returns:
- a
FileAssetLocation.Builder
ofFileAssetLocation
-
httpUrl