Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.beyondcorp/v1.AppGateway
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new AppGateway in a given project and location.
Create AppGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppGateway(name: string, args: AppGatewayArgs, opts?: CustomResourceOptions);@overload
def AppGateway(resource_name: str,
               args: AppGatewayArgs,
               opts: Optional[ResourceOptions] = None)
@overload
def AppGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               host_type: Optional[AppGatewayHostType] = None,
               type: Optional[AppGatewayType] = None,
               app_gateway_id: Optional[str] = None,
               display_name: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               request_id: Optional[str] = None)func NewAppGateway(ctx *Context, name string, args AppGatewayArgs, opts ...ResourceOption) (*AppGateway, error)public AppGateway(string name, AppGatewayArgs args, CustomResourceOptions? opts = null)
public AppGateway(String name, AppGatewayArgs args)
public AppGateway(String name, AppGatewayArgs args, CustomResourceOptions options)
type: google-native:beyondcorp/v1:AppGateway
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 AppGatewayArgs
- 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 AppGatewayArgs
- 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 AppGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var appGatewayResource = new GoogleNative.BeyondCorp.V1.AppGateway("appGatewayResource", new()
{
    HostType = GoogleNative.BeyondCorp.V1.AppGatewayHostType.HostTypeUnspecified,
    Type = GoogleNative.BeyondCorp.V1.AppGatewayType.TypeUnspecified,
    AppGatewayId = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
});
example, err := beyondcorp.NewAppGateway(ctx, "appGatewayResource", &beyondcorp.AppGatewayArgs{
	HostType:     beyondcorp.AppGatewayHostTypeHostTypeUnspecified,
	Type:         beyondcorp.AppGatewayTypeTypeUnspecified,
	AppGatewayId: pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Name:      pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
})
var appGatewayResource = new AppGateway("appGatewayResource", AppGatewayArgs.builder()
    .hostType("HOST_TYPE_UNSPECIFIED")
    .type("TYPE_UNSPECIFIED")
    .appGatewayId("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .build());
app_gateway_resource = google_native.beyondcorp.v1.AppGateway("appGatewayResource",
    host_type=google_native.beyondcorp.v1.AppGatewayHostType.HOST_TYPE_UNSPECIFIED,
    type=google_native.beyondcorp.v1.AppGatewayType.TYPE_UNSPECIFIED,
    app_gateway_id="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string")
const appGatewayResource = new google_native.beyondcorp.v1.AppGateway("appGatewayResource", {
    hostType: google_native.beyondcorp.v1.AppGatewayHostType.HostTypeUnspecified,
    type: google_native.beyondcorp.v1.AppGatewayType.TypeUnspecified,
    appGatewayId: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
});
type: google-native:beyondcorp/v1:AppGateway
properties:
    appGatewayId: string
    displayName: string
    hostType: HOST_TYPE_UNSPECIFIED
    labels:
        string: string
    location: string
    name: string
    project: string
    requestId: string
    type: TYPE_UNSPECIFIED
AppGateway 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 AppGateway resource accepts the following input properties:
- HostType Pulumi.Google Native. Beyond Corp. V1. App Gateway Host Type 
- The type of hosting used by the AppGateway.
- Type
Pulumi.Google Native. Beyond Corp. V1. App Gateway Type 
- The type of network connectivity used by the AppGateway.
- AppGateway stringId 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- DisplayName string
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- Labels Dictionary<string, string>
- Optional. Resource labels to represent user provided metadata.
- Location string
- Name string
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- Project string
- RequestId string
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- HostType AppGateway Host Type 
- The type of hosting used by the AppGateway.
- Type
AppGateway Type 
- The type of network connectivity used by the AppGateway.
- AppGateway stringId 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- DisplayName string
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- Labels map[string]string
- Optional. Resource labels to represent user provided metadata.
- Location string
- Name string
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- Project string
- RequestId string
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- hostType AppGateway Host Type 
- The type of hosting used by the AppGateway.
- type
AppGateway Type 
- The type of network connectivity used by the AppGateway.
- appGateway StringId 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- displayName String
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- labels Map<String,String>
- Optional. Resource labels to represent user provided metadata.
- location String
- name String
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- project String
- requestId String
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- hostType AppGateway Host Type 
- The type of hosting used by the AppGateway.
- type
AppGateway Type 
- The type of network connectivity used by the AppGateway.
- appGateway stringId 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- displayName string
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- labels {[key: string]: string}
- Optional. Resource labels to represent user provided metadata.
- location string
- name string
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- project string
- requestId string
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- host_type AppGateway Host Type 
- The type of hosting used by the AppGateway.
- type
AppGateway Type 
- The type of network connectivity used by the AppGateway.
- app_gateway_ strid 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- display_name str
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- labels Mapping[str, str]
- Optional. Resource labels to represent user provided metadata.
- location str
- name str
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- project str
- request_id str
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- hostType "HOST_TYPE_UNSPECIFIED" | "GCP_REGIONAL_MIG"
- The type of hosting used by the AppGateway.
- type "TYPE_UNSPECIFIED" | "TCP_PROXY"
- The type of network connectivity used by the AppGateway.
- appGateway StringId 
- Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
- displayName String
- Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
- labels Map<String>
- Optional. Resource labels to represent user provided metadata.
- location String
- name String
- Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
- project String
- requestId String
- Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Outputs
All input properties are implicitly available as output properties. Additionally, the AppGateway resource produces the following output properties:
- AllocatedConnections List<Pulumi.Google Native. Beyond Corp. V1. Outputs. Allocated Connection Response> 
- A list of connections allocated for the Gateway
- CreateTime string
- Timestamp when the resource was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the AppGateway.
- Uid string
- A unique identifier for the instance generated by the system.
- UpdateTime string
- Timestamp when the resource was last modified.
- Uri string
- Server-defined URI for this resource.
- AllocatedConnections []AllocatedConnection Response 
- A list of connections allocated for the Gateway
- CreateTime string
- Timestamp when the resource was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the AppGateway.
- Uid string
- A unique identifier for the instance generated by the system.
- UpdateTime string
- Timestamp when the resource was last modified.
- Uri string
- Server-defined URI for this resource.
- allocatedConnections List<AllocatedConnection Response> 
- A list of connections allocated for the Gateway
- createTime String
- Timestamp when the resource was created.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the AppGateway.
- uid String
- A unique identifier for the instance generated by the system.
- updateTime String
- Timestamp when the resource was last modified.
- uri String
- Server-defined URI for this resource.
- allocatedConnections AllocatedConnection Response[] 
- A list of connections allocated for the Gateway
- createTime string
- Timestamp when the resource was created.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the AppGateway.
- uid string
- A unique identifier for the instance generated by the system.
- updateTime string
- Timestamp when the resource was last modified.
- uri string
- Server-defined URI for this resource.
- allocated_connections Sequence[AllocatedConnection Response] 
- A list of connections allocated for the Gateway
- create_time str
- Timestamp when the resource was created.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the AppGateway.
- uid str
- A unique identifier for the instance generated by the system.
- update_time str
- Timestamp when the resource was last modified.
- uri str
- Server-defined URI for this resource.
- allocatedConnections List<Property Map>
- A list of connections allocated for the Gateway
- createTime String
- Timestamp when the resource was created.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the AppGateway.
- uid String
- A unique identifier for the instance generated by the system.
- updateTime String
- Timestamp when the resource was last modified.
- uri String
- Server-defined URI for this resource.
Supporting Types
AllocatedConnectionResponse, AllocatedConnectionResponseArgs      
- IngressPort int
- The ingress port of an allocated connection
- PscUri string
- The PSC uri of an allocated connection
- IngressPort int
- The ingress port of an allocated connection
- PscUri string
- The PSC uri of an allocated connection
- ingressPort Integer
- The ingress port of an allocated connection
- pscUri String
- The PSC uri of an allocated connection
- ingressPort number
- The ingress port of an allocated connection
- pscUri string
- The PSC uri of an allocated connection
- ingress_port int
- The ingress port of an allocated connection
- psc_uri str
- The PSC uri of an allocated connection
- ingressPort Number
- The ingress port of an allocated connection
- pscUri String
- The PSC uri of an allocated connection
AppGatewayHostType, AppGatewayHostTypeArgs        
- HostType Unspecified 
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- GcpRegional Mig 
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
- AppGateway Host Type Host Type Unspecified 
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- AppGateway Host Type Gcp Regional Mig 
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
- HostType Unspecified 
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- GcpRegional Mig 
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
- HostType Unspecified 
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- GcpRegional Mig 
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
- HOST_TYPE_UNSPECIFIED
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- GCP_REGIONAL_MIG
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
- "HOST_TYPE_UNSPECIFIED"
- HOST_TYPE_UNSPECIFIEDDefault value. This value is unused.
- "GCP_REGIONAL_MIG"
- GCP_REGIONAL_MIGAppGateway hosted in a GCP regional managed instance group.
AppGatewayType, AppGatewayTypeArgs      
- TypeUnspecified 
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- TcpProxy 
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
- AppGateway Type Type Unspecified 
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- AppGateway Type Tcp Proxy 
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
- TypeUnspecified 
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- TcpProxy 
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
- TypeUnspecified 
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- TcpProxy 
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
- TYPE_UNSPECIFIED
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- TCP_PROXY
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
- "TYPE_UNSPECIFIED"
- TYPE_UNSPECIFIEDDefault value. This value is unused.
- "TCP_PROXY"
- TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.