We recommend new projects start with resources from the AWS provider.
aws-native.refactorspaces.Application
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Application resource accepts the following input properties:
- Environment
Identifier string - The unique identifier of the environment.
- Proxy
Type Pulumi.Aws Native. Refactor Spaces. Application Proxy Type - The proxy type of the proxy created within the application.
- Vpc
Id string - The ID of the virtual private cloud (VPC).
- Api
Gateway Pulumi.Proxy Aws Native. Refactor Spaces. Inputs. Application Api Gateway Proxy Input - The endpoint URL of the Amazon API Gateway proxy.
- Name string
- The name of the application.
- List<Pulumi.
Aws Native. Inputs. Tag> - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- Environment
Identifier string - The unique identifier of the environment.
- Proxy
Type ApplicationProxy Type - The proxy type of the proxy created within the application.
- Vpc
Id string - The ID of the virtual private cloud (VPC).
- Api
Gateway ApplicationProxy Api Gateway Proxy Input Args - The endpoint URL of the Amazon API Gateway proxy.
- Name string
- The name of the application.
- Tag
Args - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- environment
Identifier String - The unique identifier of the environment.
- proxy
Type ApplicationProxy Type - The proxy type of the proxy created within the application.
- vpc
Id String - The ID of the virtual private cloud (VPC).
- api
Gateway ApplicationProxy Api Gateway Proxy Input - The endpoint URL of the Amazon API Gateway proxy.
- name String
- The name of the application.
- List<Tag>
- Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- environment
Identifier string - The unique identifier of the environment.
- proxy
Type ApplicationProxy Type - The proxy type of the proxy created within the application.
- vpc
Id string - The ID of the virtual private cloud (VPC).
- api
Gateway ApplicationProxy Api Gateway Proxy Input - The endpoint URL of the Amazon API Gateway proxy.
- name string
- The name of the application.
- 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 ApplicationProxy Type - The proxy type of the proxy created within the application.
- vpc_
id str - The ID of the virtual private cloud (VPC).
- api_
gateway_ Applicationproxy Api Gateway Proxy Input Args - The endpoint URL of the Amazon API Gateway proxy.
- name str
- The name of the application.
- Sequence[Tag
Args] - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- environment
Identifier String - The unique identifier of the environment.
- proxy
Type "API_GATEWAY" - The proxy type of the proxy created within the application.
- vpc
Id String - The ID of the virtual private cloud (VPC).
- api
Gateway Property MapProxy - The endpoint URL of the Amazon API Gateway proxy.
- name String
- The name of the application.
- 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:
- Api
Gateway stringId - The resource ID of the API Gateway for the proxy.
- Application
Identifier 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.
- Nlb
Arn string - The Amazon Resource Name (ARN) of the Network Load Balancer .
- Nlb
Name string - The name of the Network Load Balancer configured by the API Gateway proxy.
- Proxy
Url string - The endpoint URL of the Amazon API Gateway proxy.
- Stage
Name string - The name of the API Gateway stage. The name defaults to
prod
. - Vpc
Link stringId - The
VpcLink
ID of the API Gateway proxy.
- Api
Gateway stringId - The resource ID of the API Gateway for the proxy.
- Application
Identifier 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.
- Nlb
Arn string - The Amazon Resource Name (ARN) of the Network Load Balancer .
- Nlb
Name string - The name of the Network Load Balancer configured by the API Gateway proxy.
- Proxy
Url string - The endpoint URL of the Amazon API Gateway proxy.
- Stage
Name string - The name of the API Gateway stage. The name defaults to
prod
. - Vpc
Link stringId - The
VpcLink
ID of the API Gateway proxy.
- api
Gateway StringId - The resource ID of the API Gateway for the proxy.
- application
Identifier 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.
- nlb
Arn String - The Amazon Resource Name (ARN) of the Network Load Balancer .
- nlb
Name String - The name of the Network Load Balancer configured by the API Gateway proxy.
- proxy
Url String - The endpoint URL of the Amazon API Gateway proxy.
- stage
Name String - The name of the API Gateway stage. The name defaults to
prod
. - vpc
Link StringId - The
VpcLink
ID of the API Gateway proxy.
- api
Gateway stringId - The resource ID of the API Gateway for the proxy.
- application
Identifier 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.
- nlb
Arn string - The Amazon Resource Name (ARN) of the Network Load Balancer .
- nlb
Name string - The name of the Network Load Balancer configured by the API Gateway proxy.
- proxy
Url string - The endpoint URL of the Amazon API Gateway proxy.
- stage
Name string - The name of the API Gateway stage. The name defaults to
prod
. - vpc
Link stringId - The
VpcLink
ID of the API Gateway proxy.
- api_
gateway_ strid - 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_ strid - The
VpcLink
ID of the API Gateway proxy.
- api
Gateway StringId - The resource ID of the API Gateway for the proxy.
- application
Identifier 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.
- nlb
Arn String - The Amazon Resource Name (ARN) of the Network Load Balancer .
- nlb
Name String - The name of the Network Load Balancer configured by the API Gateway proxy.
- proxy
Url String - The endpoint URL of the Amazon API Gateway proxy.
- stage
Name String - The name of the API Gateway stage. The name defaults to
prod
. - vpc
Link StringId - The
VpcLink
ID of the API Gateway proxy.
Supporting Types
ApplicationApiGatewayEndpointType, ApplicationApiGatewayEndpointTypeArgs
- Regional
- REGIONAL
- Private
- PRIVATE
- Application
Api Gateway Endpoint Type Regional - REGIONAL
- Application
Api Gateway Endpoint Type Private - PRIVATE
- Regional
- REGIONAL
- Private
- PRIVATE
- Regional
- REGIONAL
- Private
- PRIVATE
- REGIONAL
- REGIONAL
- PRIVATE
- PRIVATE
- "REGIONAL"
- REGIONAL
- "PRIVATE"
- PRIVATE
ApplicationApiGatewayProxyInput, ApplicationApiGatewayProxyInputArgs
- Endpoint
Type Pulumi.Aws Native. Refactor Spaces. Application Api Gateway Endpoint Type 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 string - The name of the API Gateway stage. The name defaults to
prod
.
- Endpoint
Type ApplicationApi Gateway Endpoint Type 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 string - The name of the API Gateway stage. The name defaults to
prod
.
- endpoint
Type ApplicationApi Gateway Endpoint Type 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 String - The name of the API Gateway stage. The name defaults to
prod
.
- endpoint
Type ApplicationApi Gateway Endpoint Type 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 string - The name of the API Gateway stage. The name defaults to
prod
.
- endpoint_
type ApplicationApi Gateway Endpoint Type 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
.
- endpoint
Type "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 ) .- stage
Name String - The name of the API Gateway stage. The name defaults to
prod
.
ApplicationProxyType, ApplicationProxyTypeArgs
- Api
Gateway - API_GATEWAY
- Application
Proxy Type Api Gateway - API_GATEWAY
- Api
Gateway - API_GATEWAY
- Api
Gateway - API_GATEWAY
- API_GATEWAY
- API_GATEWAY
- "API_GATEWAY"
- API_GATEWAY
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.