FileDestination

class aws_cdk.cloud_assembly_schema.FileDestination(*, assume_role_additional_options=None, assume_role_arn=None, assume_role_external_id=None, region=None, bucket_name, object_key)

Bases: AwsDestination

Where in S3 a file asset needs to be published.

Parameters:

  • assume_role_additional_options (Optional[Mapping[str, Any]]) – Additional options to pass to STS when assuming the role. - RoleArn should not be used. Use the dedicated assumeRoleArn property instead. - ExternalId should not be used. Use the dedicated assumeRoleExternalId instead. Default: - No additional options.

  • assume_role_arn (Optional[str]) – The role that needs to be assumed while publishing this asset. Default: - No role will be assumed

  • assume_role_external_id (Optional[str]) – The ExternalId that needs to be supplied while assuming this role. Default: - No ExternalId will be supplied

  • region (Optional[str]) – The region where this asset will need to be published. Default: - Current region

  • bucket_name (str) – The name of the bucket.

  • object_key (str) – The destination object key.

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.cloud_assembly_schema as cloud_assembly_schema

# assume_role_additional_options: Any

file_destination = cloud_assembly_schema.FileDestination(
    bucket_name="bucketName",
    object_key="objectKey",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    assume_role_arn="assumeRoleArn",
    assume_role_external_id="assumeRoleExternalId",
    region="region"
)

Attributes

assume_role_additional_options

Additional options to pass to STS when assuming the role.

  • RoleArn should not be used. Use the dedicated assumeRoleArn property instead.

  • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

Default:

  • No additional options.

See:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

assume_role_arn

The role that needs to be assumed while publishing this asset.

Default:

  • No role will be assumed

assume_role_external_id

The ExternalId that needs to be supplied while assuming this role.

Default:

  • No ExternalId will be supplied

bucket_name

The name of the bucket.

object_key

The destination object key.

region

The region where this asset will need to be published.

Default:

  • Current region