Interface ICfnWebAppProps

Properties for defining a CfnWebApp.

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnWebAppProps

Syntax (vb)

Public Interface ICfnWebAppProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var cfnWebAppProps = new CfnWebAppProps {
                 IdentityProviderDetails = new IdentityProviderDetailsProperty {
                     ApplicationArn = "applicationArn",
                     InstanceArn = "instanceArn",
                     Role = "role"
                 },

                 // the properties below are optional
                 AccessEndpoint = "accessEndpoint",
                 EndpointDetails = new EndpointDetailsProperty {
                     Vpc = new VpcProperty {
                         SecurityGroupIds = new [] { "securityGroupIds" },
                         SubnetIds = new [] { "subnetIds" },
                         VpcId = "vpcId"
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WebAppCustomization = new WebAppCustomizationProperty {
                     FaviconFile = "faviconFile",
                     LogoFile = "logoFile",
                     Title = "title"
                 },
                 WebAppEndpointPolicy = "webAppEndpointPolicy",
                 WebAppUnits = new WebAppUnitsProperty {
                     Provisioned = 123
                 }
             };

Synopsis

Properties

AccessEndpoint	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.
EndpointDetails	Properties for defining a CfnWebApp.
IdentityProviderDetails	You can provide a structure that contains the details for the identity provider to use with your web app.
Tags	Key-value pairs that can be used to group and search for web apps.
WebAppCustomization	A structure that contains the customization fields for the web app.
WebAppEndpointPolicy	Setting for the type of endpoint policy for the web app. The default value is STANDARD .
WebAppUnits	A union that contains the value for number of concurrent connections or the user sessions on your web app.

Properties

AccessEndpoint

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.

string? AccessEndpoint { get; }

Property Value

string

Remarks

You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-accessendpoint

EndpointDetails

Properties for defining a CfnWebApp.

object? EndpointDetails { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-endpointdetails

Type union: either IResolvable or CfnWebApp.IEndpointDetailsProperty

IdentityProviderDetails

You can provide a structure that contains the details for the identity provider to use with your web app.

object IdentityProviderDetails { get; }

Property Value

object

Remarks

For more details about this parameter, see Configure your identity provider for Transfer Family web apps .

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

Type union: either IResolvable or CfnWebApp.IIdentityProviderDetailsProperty

Tags

Key-value pairs that can be used to group and search for web apps.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

Tags are metadata attached to web apps for any purpose.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-tags

WebAppCustomization

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

object? WebAppCustomization { get; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnWebApp.IWebAppCustomizationProperty

WebAppEndpointPolicy

Setting for the type of endpoint policy for the web app. The default value is STANDARD .

string? WebAppEndpointPolicy { get; }

Property Value

string

Remarks

If your web app was created in an AWS GovCloud (US) Region , the value of this parameter can be FIPS , which indicates the web app endpoint is FIPS-compliant.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappendpointpolicy

WebAppUnits

A union that contains the value for number of concurrent connections or the user sessions on your web app.

object? WebAppUnits { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnWebApp.IWebAppUnitsProperty