CfnWebAppPropsMixin

class aws_cdk.mixins_preview.aws_transfer.mixins.CfnWebAppPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a web app based on specified parameters, and returns the ID for the new web app.

You can configure the web app to be publicly accessible or hosted within a VPC.

For more information about using VPC endpoints with AWS Transfer Family , see Create a Transfer Family web app in a VPC .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html
CloudformationResource:: AWS::Transfer::WebApp
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_transfer import mixins as transfer_mixins

cfn_web_app_props_mixin = transfer_mixins.CfnWebAppPropsMixin(transfer_mixins.CfnWebAppMixinProps(
    access_endpoint="accessEndpoint",
    identity_provider_details=transfer_mixins.CfnWebAppPropsMixin.IdentityProviderDetailsProperty(
        application_arn="applicationArn",
        instance_arn="instanceArn",
        role="role"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    web_app_customization=transfer_mixins.CfnWebAppPropsMixin.WebAppCustomizationProperty(
        favicon_file="faviconFile",
        logo_file="logoFile",
        title="title"
    ),
    web_app_endpoint_policy="webAppEndpointPolicy",
    web_app_units=transfer_mixins.CfnWebAppPropsMixin.WebAppUnitsProperty(
        provisioned=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Transfer::WebApp.

Parameters:

props (Union[CfnWebAppMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessEndpoint', 'identityProviderDetails', 'tags', 'webAppCustomization', 'webAppEndpointPolicy', 'webAppUnits']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

IdentityProviderDetailsProperty

class CfnWebAppPropsMixin.IdentityProviderDetailsProperty(*, application_arn=None, instance_arn=None, role=None)

Bases: object

A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.

Parameters:

application_arn (Optional[str]) – The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
instance_arn (Optional[str]) – The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
role (Optional[str]) – The IAM role in IAM Identity Center used for the web app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_transfer import mixins as transfer_mixins

identity_provider_details_property = transfer_mixins.CfnWebAppPropsMixin.IdentityProviderDetailsProperty(
    application_arn="applicationArn",
    instance_arn="instanceArn",
    role="role"
)

Attributes

application_arn

this value is set automatically when you create your web app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-applicationarn
Type:: The Amazon Resource Name (ARN) for the IAM Identity Center application

instance_arn

The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-instancearn

role

The IAM role in IAM Identity Center used for the web app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-role

WebAppCustomizationProperty

class CfnWebAppPropsMixin.WebAppCustomizationProperty(*, favicon_file=None, logo_file=None, title=None)

Bases: object

A structure that contains the customization fields for the web app.

You can provide a title, logo, and icon to customize the appearance of your web app.

Parameters:

favicon_file (Optional[str]) – Returns an icon file data string (in base64 encoding).
logo_file (Optional[str]) – Returns a logo file data string (in base64 encoding).
title (Optional[str]) – Returns the page title that you defined for your web app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_transfer import mixins as transfer_mixins

web_app_customization_property = transfer_mixins.CfnWebAppPropsMixin.WebAppCustomizationProperty(
    favicon_file="faviconFile",
    logo_file="logoFile",
    title="title"
)

Attributes

favicon_file

Returns an icon file data string (in base64 encoding).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-faviconfile

logo_file

Returns a logo file data string (in base64 encoding).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-logofile

title

Returns the page title that you defined for your web app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-title

WebAppUnitsProperty

class CfnWebAppPropsMixin.WebAppUnitsProperty(*, provisioned=None)

Bases: object

Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.

Parameters:: provisioned (Union[int, float, None]) – An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time. Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappunits.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_transfer import mixins as transfer_mixins

web_app_units_property = transfer_mixins.CfnWebAppPropsMixin.WebAppUnitsProperty(
    provisioned=123
)

Attributes

provisioned

An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.

Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappunits.html#cfn-transfer-webapp-webappunits-provisioned