Class CfnWebApp

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWebApp

Implements

IInspectable

IWebAppRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWebApp : CfnResource, IInspectable, IWebAppRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnWebApp Inherits CfnResource Implements IInspectable, IWebAppRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

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 cfnWebApp = new CfnWebApp(this, "MyCfnWebApp", 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

Constructors

CfnWebApp(Construct, string, ICfnWebAppProps)

Create a new AWS::Transfer::WebApp.

Properties

AccessEndpoint	The `AccessEndpoint` is the URL that you provide to your users for them to interact with the Transfer Family web app.
AttrArn	The Amazon Resource Name (ARN) of the web app.
AttrIdentityProviderDetailsApplicationArn	The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
AttrVpcEndpointId	Creates a web app based on specified parameters, and returns the ID for the new web app.
AttrWebAppId	The unique identifier for the web app.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a web app based on specified parameters, and returns the ID for the new web app.
CfnPropertyNames	Creates a web app based on specified parameters, and returns the ID for the new web app.
EndpointDetails	Creates a web app based on specified parameters, and returns the ID for the new web app.
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.
WebAppRef	A reference to a WebApp resource.
WebAppUnits	A union that contains the value for number of concurrent connections or the user sessions on your web app.

Methods

ArnForWebApp(IWebAppRef)	Creates a web app based on specified parameters, and returns the ID for the new web app.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWebApp(object)	Checks whether the given object is a CfnWebApp.
RenderProperties(IDictionary<string, object>)	Creates a web app based on specified parameters, and returns the ID for the new web app.

Constructors

CfnWebApp(Construct, string, ICfnWebAppProps)

Create a new AWS::Transfer::WebApp.

public CfnWebApp(Construct scope, string id, ICfnWebAppProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnWebAppProps: Resource properties.

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AccessEndpoint

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

public virtual string? AccessEndpoint { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

AttrArn

The Amazon Resource Name (ARN) of the web app.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrIdentityProviderDetailsApplicationArn

The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.

public virtual string AttrIdentityProviderDetailsApplicationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: IdentityProviderDetails.ApplicationArn

AttrVpcEndpointId

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

public virtual string AttrVpcEndpointId { get; }

Property Value

string

Remarks

CloudformationAttribute: VpcEndpointId

AttrWebAppId

The unique identifier for the web app.

public virtual string AttrWebAppId { get; }

Property Value

string

Remarks

CloudformationAttribute: WebAppId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

ExampleMetadata: fixture=_generated

EndpointDetails

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

public virtual object? EndpointDetails { get; set; }

Property Value

object

Remarks

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.

public virtual object IdentityProviderDetails { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWebApp.IIdentityProviderDetailsProperty

WebAppCustomization

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

public virtual object? WebAppCustomization { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWebApp.IWebAppCustomizationProperty

WebAppEndpointPolicy

Setting for the type of endpoint policy for the web app.

public virtual string? WebAppEndpointPolicy { get; set; }

Property Value

string

Remarks

The default value is STANDARD .

WebAppRef

A reference to a WebApp resource.

public virtual IWebAppReference WebAppRef { get; }

Property Value

IWebAppReference

Remarks

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

ExampleMetadata: fixture=_generated

WebAppUnits

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

public virtual object? WebAppUnits { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWebApp.IWebAppUnitsProperty

Methods

ArnForWebApp(IWebAppRef)

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

public static string ArnForWebApp(IWebAppRef resource)

Parameters

resource IWebAppRef

Returns

string

Remarks

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

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 cfnWebApp = new CfnWebApp(this, "MyCfnWebApp", 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
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

ExampleMetadata: fixture=_generated

IsCfnWebApp(object)

Checks whether the given object is a CfnWebApp.

public static bool IsCfnWebApp(object x)

Parameters

x object

Returns

bool

Remarks

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

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWebAppRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2