1. Packages
  2. AWS Native
  3. API Docs
  4. refactorspaces
  5. Application

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.refactorspaces.Application

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Definition of AWS::RefactorSpaces::Application Resource Type

    Create Application Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Application(name: string, args: ApplicationArgs, opts?: CustomResourceOptions);
    @overload
    def Application(resource_name: str,
                    args: ApplicationArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Application(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    environment_identifier: Optional[str] = None,
                    proxy_type: Optional[ApplicationProxyType] = None,
                    vpc_id: Optional[str] = None,
                    api_gateway_proxy: Optional[ApplicationApiGatewayProxyInputArgs] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewApplication(ctx *Context, name string, args ApplicationArgs, opts ...ResourceOption) (*Application, error)
    public Application(string name, ApplicationArgs args, CustomResourceOptions? opts = null)
    public Application(String name, ApplicationArgs args)
    public Application(String name, ApplicationArgs args, CustomResourceOptions options)
    
    type: aws-native:refactorspaces:Application
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampleapplicationResourceResourceFromRefactorspaces = new aws_native.refactorspaces.Application("exampleapplicationResourceResourceFromRefactorspaces", {
        environmentIdentifier: "string",
        proxyType: aws_native.refactorspaces.ApplicationProxyType.ApiGateway,
        vpcId: "string",
        apiGatewayProxy: {
            endpointType: aws_native.refactorspaces.ApplicationApiGatewayEndpointType.Regional,
            stageName: "string",
        },
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Application Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Application resource accepts the following input properties:

    EnvironmentIdentifier string
    The unique identifier of the environment.
    ProxyType Pulumi.AwsNative.RefactorSpaces.ApplicationProxyType
    The proxy type of the proxy created within the application.
    VpcId string
    The ID of the virtual private cloud (VPC).
    ApiGatewayProxy Pulumi.AwsNative.RefactorSpaces.Inputs.ApplicationApiGatewayProxyInput
    The endpoint URL of the Amazon API Gateway proxy.
    Name string
    The name of the application.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    EnvironmentIdentifier string
    The unique identifier of the environment.
    ProxyType ApplicationProxyType
    The proxy type of the proxy created within the application.
    VpcId string
    The ID of the virtual private cloud (VPC).
    ApiGatewayProxy ApplicationApiGatewayProxyInputArgs
    The endpoint URL of the Amazon API Gateway proxy.
    Name string
    The name of the application.
    Tags TagArgs
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    environmentIdentifier String
    The unique identifier of the environment.
    proxyType ApplicationProxyType
    The proxy type of the proxy created within the application.
    vpcId String
    The ID of the virtual private cloud (VPC).
    apiGatewayProxy ApplicationApiGatewayProxyInput
    The endpoint URL of the Amazon API Gateway proxy.
    name String
    The name of the application.
    tags List<Tag>
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    environmentIdentifier string
    The unique identifier of the environment.
    proxyType ApplicationProxyType
    The proxy type of the proxy created within the application.
    vpcId string
    The ID of the virtual private cloud (VPC).
    apiGatewayProxy ApplicationApiGatewayProxyInput
    The endpoint URL of the Amazon API Gateway proxy.
    name string
    The name of the application.
    tags Tag[]
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    environment_identifier str
    The unique identifier of the environment.
    proxy_type ApplicationProxyType
    The proxy type of the proxy created within the application.
    vpc_id str
    The ID of the virtual private cloud (VPC).
    api_gateway_proxy ApplicationApiGatewayProxyInputArgs
    The endpoint URL of the Amazon API Gateway proxy.
    name str
    The name of the application.
    tags Sequence[TagArgs]
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    environmentIdentifier String
    The unique identifier of the environment.
    proxyType "API_GATEWAY"
    The proxy type of the proxy created within the application.
    vpcId String
    The ID of the virtual private cloud (VPC).
    apiGatewayProxy Property Map
    The endpoint URL of the Amazon API Gateway proxy.
    name String
    The name of the application.
    tags List<Property Map>
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Application resource produces the following output properties:

    ApiGatewayId string
    The resource ID of the API Gateway for the proxy.
    ApplicationIdentifier string
    The unique identifier of the application.
    Arn string
    The Amazon Resource Name (ARN) of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    NlbArn string
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    NlbName string
    The name of the Network Load Balancer configured by the API Gateway proxy.
    ProxyUrl string
    The endpoint URL of the Amazon API Gateway proxy.
    StageName string
    The name of the API Gateway stage. The name defaults to prod .
    VpcLinkId string
    The VpcLink ID of the API Gateway proxy.
    ApiGatewayId string
    The resource ID of the API Gateway for the proxy.
    ApplicationIdentifier string
    The unique identifier of the application.
    Arn string
    The Amazon Resource Name (ARN) of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    NlbArn string
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    NlbName string
    The name of the Network Load Balancer configured by the API Gateway proxy.
    ProxyUrl string
    The endpoint URL of the Amazon API Gateway proxy.
    StageName string
    The name of the API Gateway stage. The name defaults to prod .
    VpcLinkId string
    The VpcLink ID of the API Gateway proxy.
    apiGatewayId String
    The resource ID of the API Gateway for the proxy.
    applicationIdentifier String
    The unique identifier of the application.
    arn String
    The Amazon Resource Name (ARN) of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    nlbArn String
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    nlbName String
    The name of the Network Load Balancer configured by the API Gateway proxy.
    proxyUrl String
    The endpoint URL of the Amazon API Gateway proxy.
    stageName String
    The name of the API Gateway stage. The name defaults to prod .
    vpcLinkId String
    The VpcLink ID of the API Gateway proxy.
    apiGatewayId string
    The resource ID of the API Gateway for the proxy.
    applicationIdentifier string
    The unique identifier of the application.
    arn string
    The Amazon Resource Name (ARN) of the application.
    id string
    The provider-assigned unique ID for this managed resource.
    nlbArn string
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    nlbName string
    The name of the Network Load Balancer configured by the API Gateway proxy.
    proxyUrl string
    The endpoint URL of the Amazon API Gateway proxy.
    stageName string
    The name of the API Gateway stage. The name defaults to prod .
    vpcLinkId string
    The VpcLink ID of the API Gateway proxy.
    api_gateway_id str
    The resource ID of the API Gateway for the proxy.
    application_identifier str
    The unique identifier of the application.
    arn str
    The Amazon Resource Name (ARN) of the application.
    id str
    The provider-assigned unique ID for this managed resource.
    nlb_arn str
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    nlb_name str
    The name of the Network Load Balancer configured by the API Gateway proxy.
    proxy_url str
    The endpoint URL of the Amazon API Gateway proxy.
    stage_name str
    The name of the API Gateway stage. The name defaults to prod .
    vpc_link_id str
    The VpcLink ID of the API Gateway proxy.
    apiGatewayId String
    The resource ID of the API Gateway for the proxy.
    applicationIdentifier String
    The unique identifier of the application.
    arn String
    The Amazon Resource Name (ARN) of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    nlbArn String
    The Amazon Resource Name (ARN) of the Network Load Balancer .
    nlbName String
    The name of the Network Load Balancer configured by the API Gateway proxy.
    proxyUrl String
    The endpoint URL of the Amazon API Gateway proxy.
    stageName String
    The name of the API Gateway stage. The name defaults to prod .
    vpcLinkId String
    The VpcLink ID of the API Gateway proxy.

    Supporting Types

    ApplicationApiGatewayEndpointType, ApplicationApiGatewayEndpointTypeArgs

    Regional
    REGIONAL
    Private
    PRIVATE
    ApplicationApiGatewayEndpointTypeRegional
    REGIONAL
    ApplicationApiGatewayEndpointTypePrivate
    PRIVATE
    Regional
    REGIONAL
    Private
    PRIVATE
    Regional
    REGIONAL
    Private
    PRIVATE
    REGIONAL
    REGIONAL
    PRIVATE
    PRIVATE
    "REGIONAL"
    REGIONAL
    "PRIVATE"
    PRIVATE

    ApplicationApiGatewayProxyInput, ApplicationApiGatewayProxyInputArgs

    EndpointType Pulumi.AwsNative.RefactorSpaces.ApplicationApiGatewayEndpointType

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    StageName string
    The name of the API Gateway stage. The name defaults to prod .
    EndpointType ApplicationApiGatewayEndpointType

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    StageName string
    The name of the API Gateway stage. The name defaults to prod .
    endpointType ApplicationApiGatewayEndpointType

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    stageName String
    The name of the API Gateway stage. The name defaults to prod .
    endpointType ApplicationApiGatewayEndpointType

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    stageName string
    The name of the API Gateway stage. The name defaults to prod .
    endpoint_type ApplicationApiGatewayEndpointType

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    stage_name str
    The name of the API Gateway stage. The name defaults to prod .
    endpointType "REGIONAL" | "PRIVATE"

    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

    stageName String
    The name of the API Gateway stage. The name defaults to prod .

    ApplicationProxyType, ApplicationProxyTypeArgs

    ApiGateway
    API_GATEWAY
    ApplicationProxyTypeApiGateway
    API_GATEWAY
    ApiGateway
    API_GATEWAY
    ApiGateway
    API_GATEWAY
    API_GATEWAY
    API_GATEWAY
    "API_GATEWAY"
    API_GATEWAY

    Tag, TagArgs

    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

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi