Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. transfer
  5. getWebApp

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.getWebApp

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Transfer::WebApp

    Using getWebApp

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebApp(args: GetWebAppArgs, opts?: InvokeOptions): Promise<GetWebAppResult>
function getWebAppOutput(args: GetWebAppOutputArgs, opts?: InvokeOptions): Output<GetWebAppResult>
    def get_web_app(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWebAppResult
def get_web_app_output(arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWebAppResult]
    func LookupWebApp(ctx *Context, args *LookupWebAppArgs, opts ...InvokeOption) (*LookupWebAppResult, error)
func LookupWebAppOutput(ctx *Context, args *LookupWebAppOutputArgs, opts ...InvokeOption) LookupWebAppResultOutput

    > Note: This function is named LookupWebApp in the Go SDK.

    public static class GetWebApp 
{
    public static Task<GetWebAppResult> InvokeAsync(GetWebAppArgs args, InvokeOptions? opts = null)
    public static Output<GetWebAppResult> Invoke(GetWebAppInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebAppResult> getWebApp(GetWebAppArgs args, InvokeOptions options)
public static Output<GetWebAppResult> getWebApp(GetWebAppArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:transfer:getWebApp
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the web app.

    getWebApp Result

    The following output properties are available:

    AccessEndpoint string
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    IdentityProviderDetails Pulumi.AwsNative.Transfer.Outputs.WebAppIdentityProviderDetails

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

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

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Key-value pairs that can be used to group and search for web apps.
    WebAppCustomization Pulumi.AwsNative.Transfer.Outputs.WebAppCustomization
    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.
    WebAppId string
    A unique identifier for the web app.
    WebAppUnits Pulumi.AwsNative.Transfer.Outputs.WebAppUnitsProperties
    A union that contains the value for number of concurrent connections or the user sessions on your web app.
    AccessEndpoint string
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    IdentityProviderDetails WebAppIdentityProviderDetails

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

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

    Tags Tag
    Key-value pairs that can be used to group and search for web apps.
    WebAppCustomization WebAppCustomization
    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.
    WebAppId string
    A unique identifier for the web app.
    WebAppUnits WebAppUnitsProperties
    A union that contains the value for number of concurrent connections or the user sessions on your web app.
    accessEndpoint String
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    identityProviderDetails WebAppIdentityProviderDetails

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

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

    tags List<Tag>
    Key-value pairs that can be used to group and search for web apps.
    webAppCustomization WebAppCustomization
    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.
    webAppId String
    A unique identifier for the web app.
    webAppUnits WebAppUnitsProperties
    A union that contains the value for number of concurrent connections or the user sessions on your web app.
    accessEndpoint string
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    identityProviderDetails WebAppIdentityProviderDetails

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

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

    tags Tag[]
    Key-value pairs that can be used to group and search for web apps.
    webAppCustomization WebAppCustomization
    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.
    webAppId string
    A unique identifier for the web app.
    webAppUnits WebAppUnitsProperties
    A union that contains the value for number of concurrent connections or the user sessions on your web app.
    access_endpoint str
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    identity_provider_details WebAppIdentityProviderDetails

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

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

    tags Sequence[root_Tag]
    Key-value pairs that can be used to group and search for web apps.
    web_app_customization WebAppCustomization
    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.
    web_app_id str
    A unique identifier for the web app.
    web_app_units WebAppUnitsProperties
    A union that contains the value for number of concurrent connections or the user sessions on your web app.
    accessEndpoint String
    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the web app.
    identityProviderDetails Property Map

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

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

    tags List<Property Map>
    Key-value pairs that can be used to group and search for web apps.
    webAppCustomization Property Map
    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.
    webAppId String
    A unique identifier for the web app.
    webAppUnits Property Map
    A union that contains the value for number of concurrent connections or the user sessions on your web app.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WebAppCustomization

    FaviconFile string
    Specifies a favicon to display in the browser tab.
    LogoFile string
    Specifies a logo to display on the web app.
    Title string
    Specifies a title to display on the web app.
    FaviconFile string
    Specifies a favicon to display in the browser tab.
    LogoFile string
    Specifies a logo to display on the web app.
    Title string
    Specifies a title to display on the web app.
    faviconFile String
    Specifies a favicon to display in the browser tab.
    logoFile String
    Specifies a logo to display on the web app.
    title String
    Specifies a title to display on the web app.
    faviconFile string
    Specifies a favicon to display in the browser tab.
    logoFile string
    Specifies a logo to display on the web app.
    title string
    Specifies a title to display on the web app.
    favicon_file str
    Specifies a favicon to display in the browser tab.
    logo_file str
    Specifies a logo to display on the web app.
    title str
    Specifies a title to display on the web app.
    faviconFile String
    Specifies a favicon to display in the browser tab.
    logoFile String
    Specifies a logo to display on the web app.
    title String
    Specifies a title to display on the web app.

    WebAppIdentityProviderDetails

    ApplicationArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
    InstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    Role string
    The IAM role in IAM Identity Center used for the web app.
    ApplicationArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
    InstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    Role string
    The IAM role in IAM Identity Center used for the web app.
    applicationArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
    instanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    role String
    The IAM role in IAM Identity Center used for the web app.
    applicationArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
    instanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    role string
    The IAM role in IAM Identity Center used for the web app.
    application_arn 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 str
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    role str
    The IAM role in IAM Identity Center used for the web app.
    applicationArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.
    instanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
    role String
    The IAM role in IAM Identity Center used for the web app.

    WebAppUnitsProperties

    provisioned Integer

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native