Class FileAssetLocation

The location of the published file asset.

Inheritance

object

FileAssetLocation

Implements

IFileAssetLocation

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FileAssetLocation : IFileAssetLocation

Syntax (vb)

Public Class FileAssetLocation Implements IFileAssetLocation

Remarks

This is where the asset can be consumed at runtime.

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var fileAssetLocation = new FileAssetLocation {
                 BucketName = "bucketName",
                 HttpUrl = "httpUrl",
                 ObjectKey = "objectKey",
                 S3ObjectUrl = "s3ObjectUrl",

                 // the properties below are optional
                 KmsKeyArn = "kmsKeyArn",
                 S3ObjectUrlWithPlaceholders = "s3ObjectUrlWithPlaceholders"
             };

Synopsis

Constructors

FileAssetLocation()

The location of the published file asset.

Properties

BucketName	The name of the Amazon S3 bucket.
HttpUrl	The HTTP URL of this asset on Amazon S3.
KmsKeyArn	The ARN of the KMS key used to encrypt the file asset bucket, if any.
ObjectKey	The Amazon S3 object key.
S3ObjectUrl	The S3 URL of this asset on Amazon S3.
S3ObjectUrlWithPlaceholders	Like `s3ObjectUrl`, but not suitable for CloudFormation consumption.

Constructors

FileAssetLocation()

The location of the published file asset.

public FileAssetLocation()

Remarks

This is where the asset can be consumed at runtime.

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var fileAssetLocation = new FileAssetLocation {
                 BucketName = "bucketName",
                 HttpUrl = "httpUrl",
                 ObjectKey = "objectKey",
                 S3ObjectUrl = "s3ObjectUrl",

                 // the properties below are optional
                 KmsKeyArn = "kmsKeyArn",
                 S3ObjectUrlWithPlaceholders = "s3ObjectUrlWithPlaceholders"
             };

Properties

BucketName

The name of the Amazon S3 bucket.

public string BucketName { get; set; }

Property Value

string

Remarks

This is where the asset can be consumed at runtime.

ExampleMetadata: fixture=_generated

HttpUrl

The HTTP URL of this asset on Amazon S3.

public string HttpUrl { get; set; }

Property Value

string

Remarks

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

KmsKeyArn

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

public string? KmsKeyArn { get; set; }

Property Value

string

Remarks

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.

ObjectKey

The Amazon S3 object key.

public string ObjectKey { get; set; }

Property Value

string

Remarks

This is where the asset can be consumed at runtime.

ExampleMetadata: fixture=_generated

S3ObjectUrl

The S3 URL of this asset on Amazon S3.

public string S3ObjectUrl { get; set; }

Property Value

string

Remarks

This value suitable for inclusion in a CloudFormation template, and may be an encoded token.

Example value: s3://mybucket/myobject

S3ObjectUrlWithPlaceholders

Like s3ObjectUrl, but not suitable for CloudFormation consumption.

public string? S3ObjectUrlWithPlaceholders { get; set; }

Property Value

string

Remarks

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

Default: - This feature cannot be used

Implements

IFileAssetLocation