Package software.amazon.awscdk.app.staging.synthesizer.alpha

Interface FileStagingLocation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileStagingLocation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.541Z")
@Stability(Experimental)
public interface FileStagingLocation
extends software.amazon.jsii.JsiiSerializable

(experimental) Information returned by the Staging Stack for each file asset.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.app.staging.synthesizer.alpha.*;
 import software.amazon.awscdk.*;
 Stack stack;
 FileStagingLocation fileStagingLocation = FileStagingLocation.builder()
         .bucketName("bucketName")
         // the properties below are optional
         .assumeRoleArn("assumeRoleArn")
         .dependencyStack(stack)
         .prefix("prefix")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FileStagingLocation.Builder	builder()
default String	getAssumeRoleArn()	(experimental) The ARN to assume to write files to this bucket.
String	getBucketName()	(experimental) The name of the staging bucket.
default Stack	getDependencyStack()	(experimental) The stack that creates this bucket (leads to dependencies on it).
default String	getPrefix()	(experimental) A prefix to add to the keys.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Experimental)
@NotNull
String getBucketName()

(experimental) The name of the staging bucket.

getAssumeRoleArn

@Stability(Experimental)
@Nullable
default String getAssumeRoleArn()

(experimental) The ARN to assume to write files to this bucket.

Default: - Don't assume a role

getDependencyStack

@Stability(Experimental)
@Nullable
default Stack getDependencyStack()

(experimental) The stack that creates this bucket (leads to dependencies on it).

Default: - Don't add dependencies

getPrefix

@Stability(Experimental)
@Nullable
default String getPrefix()

(experimental) A prefix to add to the keys.

Default: ''

builder

@Stability(Experimental)
static FileStagingLocation.Builder builder()

Returns:

a FileStagingLocation.Builder of FileStagingLocation