ObtainStagingResourcesContext

class aws_cdk.app_staging_synthesizer_alpha.ObtainStagingResourcesContext(*, environment_string, qualifier, deploy_role_arn=None)

Bases: object

(experimental) Context parameters for the ‘obtainStagingResources’ function.

Parameters:

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

• qualifier (str) – (experimental) The qualifier passed to the synthesizer. The staging stack shouldn’t need this, but it might.

• deploy_role_arn (Optional[str]) – (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

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.app_staging_synthesizer_alpha as app_staging_synthesizer_alpha

obtain_staging_resources_context = app_staging_synthesizer_alpha.ObtainStagingResourcesContext(
    environment_string="environmentString",
    qualifier="qualifier",

    # the properties below are optional
    deploy_role_arn="deployRoleArn"
)

Attributes

deploy_role_arn

(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

Stability:

experimental

environment_string

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

Stability:

experimental

qualifier

(experimental) The qualifier passed to the synthesizer.

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

Stability:

experimental