Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1beta
  6. Gateway

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigateway/v1beta.Gateway

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new Gateway in a given project and location. Auto-naming is currently not supported for this resource.

Create Gateway Resource

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

Constructor syntax

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_config: Optional[str] = None,
            gateway_id: Optional[str] = None,
            display_name: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            project: Optional[str] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

type: google-native:apigateway/v1beta:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayArgs
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 google_nativeGatewayResource = new GoogleNative.APIGateway.V1Beta.Gateway("google-nativeGatewayResource", new()
{
    ApiConfig = "string",
    GatewayId = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});
Copy
example, err := apigatewayv1beta.NewGateway(ctx, "google-nativeGatewayResource", &apigatewayv1beta.GatewayArgs{
	ApiConfig:   pulumi.String("string"),
	GatewayId:   pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var google_nativeGatewayResource = new Gateway("google-nativeGatewayResource", GatewayArgs.builder()
    .apiConfig("string")
    .gatewayId("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());
Copy
google_native_gateway_resource = google_native.apigateway.v1beta.Gateway("google-nativeGatewayResource",
    api_config="string",
    gateway_id="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    project="string")
Copy
const google_nativeGatewayResource = new google_native.apigateway.v1beta.Gateway("google-nativeGatewayResource", {
    apiConfig: "string",
    gatewayId: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});
Copy
type: google-native:apigateway/v1beta:Gateway
properties:
    apiConfig: string
    displayName: string
    gatewayId: string
    labels:
        string: string
    location: string
    project: string
Copy

Gateway 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 Gateway resource accepts the following input properties:

ApiConfig This property is required. string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
DisplayName string
Optional. Display name.
Labels Dictionary<string, string>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
ApiConfig This property is required. string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
DisplayName string
Optional. Display name.
Labels map[string]string
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
apiConfig This property is required. String
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
displayName String
Optional. Display name.
labels Map<String,String>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
apiConfig This property is required. string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
gatewayId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
displayName string
Optional. Display name.
labels {[key: string]: string}
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
api_config This property is required. str
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
gateway_id
This property is required.
Changes to this property will trigger replacement.
str
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
display_name str
Optional. Display name.
labels Mapping[str, str]
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
apiConfig This property is required. String
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
displayName String
Optional. Display name.
labels Map<String>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String

Outputs

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

CreateTime string
Created time.
DefaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
State string
The current state of the Gateway.
UpdateTime string
Updated time.
CreateTime string
Created time.
DefaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
State string
The current state of the Gateway.
UpdateTime string
Updated time.
createTime String
Created time.
defaultHostname String
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state String
The current state of the Gateway.
updateTime String
Updated time.
createTime string
Created time.
defaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state string
The current state of the Gateway.
updateTime string
Updated time.
create_time str
Created time.
default_hostname str
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state str
The current state of the Gateway.
update_time str
Updated time.
createTime String
Created time.
defaultHostname String
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state String
The current state of the Gateway.
updateTime String
Updated time.

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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native