software.amazon.awscdk.core

Class FileAssetLocation.Builder

java.lang.Object

software.amazon.awscdk.core.FileAssetLocation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FileAssetLocation>

Enclosing interface:

FileAssetLocation

@Stability(value=Stable)
public static final class FileAssetLocation.Builder
extends Object
implements software.amazon.jsii.Builder<FileAssetLocation>

A builder for FileAssetLocation

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FileAssetLocation.Builder	bucketName(String bucketName) Sets the value of FileAssetLocation.getBucketName()
FileAssetLocation	build() Builds the configured instance.
FileAssetLocation.Builder	httpUrl(String httpUrl) Sets the value of FileAssetLocation.getHttpUrl()
FileAssetLocation.Builder	kmsKeyArn(String kmsKeyArn) Deprecated. Since bootstrap bucket v4, the key policy properly allows use of the key via the bucket and no additional parameters have to be granted anymore.
FileAssetLocation.Builder	objectKey(String objectKey) Sets the value of FileAssetLocation.getObjectKey()
FileAssetLocation.Builder	s3ObjectUrl(String s3ObjectUrl) Sets the value of FileAssetLocation.getS3ObjectUrl()
FileAssetLocation.Builder	s3Url(String s3Url) Deprecated. use `httpUrl`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bucketName

@Stability(value=Stable)
public FileAssetLocation.Builder bucketName(String bucketName)

Sets the value of FileAssetLocation.getBucketName()

Parameters:

bucketName - The name of the Amazon S3 bucket. This parameter is required.

Returns:

this

httpUrl

@Stability(value=Stable)
public FileAssetLocation.Builder httpUrl(String httpUrl)

Sets the value of FileAssetLocation.getHttpUrl()

Parameters:

httpUrl - The HTTP URL of this asset on Amazon S3. This parameter is required.

Returns:

this

objectKey

@Stability(value=Stable)
public FileAssetLocation.Builder objectKey(String objectKey)

Sets the value of FileAssetLocation.getObjectKey()

Parameters:

objectKey - The Amazon S3 object key. This parameter is required.

Returns:

this

s3ObjectUrl

@Stability(value=Stable)
public FileAssetLocation.Builder s3ObjectUrl(String s3ObjectUrl)

Sets the value of FileAssetLocation.getS3ObjectUrl()

Parameters:

s3ObjectUrl - The S3 URL of this asset on Amazon S3. This parameter is required.

Returns:

this

s3Url

@Stability(value=Deprecated)
 @Deprecated
public FileAssetLocation.Builder s3Url(String s3Url)

Deprecated. use `httpUrl`

Sets the value of FileAssetLocation.getS3Url()

Parameters:

s3Url - The HTTP URL of this asset on Amazon S3. This parameter is required.

Returns:

this

kmsKeyArn

@Stability(value=Deprecated)
 @Deprecated
public FileAssetLocation.Builder kmsKeyArn(String kmsKeyArn)

Deprecated. Since bootstrap bucket v4, the key policy properly allows use of the key via the bucket and no additional parameters have to be granted anymore.

Sets the value of FileAssetLocation.getKmsKeyArn()

Parameters:

kmsKeyArn - 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.

Returns:

this

build

@Stability(value=Stable)
public FileAssetLocation build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FileAssetLocation>

Returns:

a new instance of FileAssetLocation

Throws:

NullPointerException - if any required attribute was not provided