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

Interface ObtainStagingResourcesContext

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ObtainStagingResourcesContext.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:46.298Z")
@Stability(Experimental)
public interface ObtainStagingResourcesContext
extends software.amazon.jsii.JsiiSerializable

(experimental) Context parameters for the 'obtainStagingResources' function.

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.*;
 ObtainStagingResourcesContext obtainStagingResourcesContext = ObtainStagingResourcesContext.builder()
         .environmentString("environmentString")
         .qualifier("qualifier")
         // the properties below are optional
         .deployRoleArn("deployRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ObtainStagingResourcesContext.Builder	builder()
default String	getDeployRoleArn()	(experimental) The ARN of the deploy action role, if given.
String	getEnvironmentString()	(experimental) A unique string describing the environment that is guaranteed not to have tokens in it.
String	getQualifier()	(experimental) The qualifier passed to the synthesizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnvironmentString

@Stability(Experimental)
@NotNull
String getEnvironmentString()

(experimental) A unique string describing the environment that is guaranteed not to have tokens in it.

getQualifier

@Stability(Experimental)
@NotNull
String getQualifier()

(experimental) The qualifier passed to the synthesizer.

The staging stack shouldn't need this, but it might.

getDeployRoleArn

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

(experimental) The ARN of the deploy action role, if given.

This role will need permissions to read from to the staging resources.

Default: - Deploy role ARN is unknown

builder

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

Returns:

a ObtainStagingResourcesContext.Builder of ObtainStagingResourcesContext