Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigateway/v1.Gateway
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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/v1:Gateway
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 GatewayArgs
- 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 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 string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 gatewayResource = new GoogleNative.APIGateway.V1.Gateway("gatewayResource", new()
{
ApiConfig = "string",
GatewayId = "string",
DisplayName = "string",
Labels =
{
{ "string", "string" },
},
Location = "string",
Project = "string",
});
example, err := apigateway.NewGateway(ctx, "gatewayResource", &apigateway.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"),
})
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
.apiConfig("string")
.gatewayId("string")
.displayName("string")
.labels(Map.of("string", "string"))
.location("string")
.project("string")
.build());
gateway_resource = google_native.apigateway.v1.Gateway("gatewayResource",
api_config="string",
gateway_id="string",
display_name="string",
labels={
"string": "string",
},
location="string",
project="string")
const gatewayResource = new google_native.apigateway.v1.Gateway("gatewayResource", {
apiConfig: "string",
gatewayId: "string",
displayName: "string",
labels: {
string: "string",
},
location: "string",
project: "string",
});
type: google-native:apigateway/v1:Gateway
properties:
apiConfig: string
displayName: string
gatewayId: string
labels:
string: string
location: string
project: string
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:
- Api
Config string - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- Gateway
Id string - Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
- Display
Name 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 string
- Project string
- Api
Config string - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- Gateway
Id string - Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
- Display
Name 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 string
- Project string
- api
Config String - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- gateway
Id String - Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
- display
Name 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 String
- project String
- api
Config string - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- gateway
Id string - Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
- display
Name 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 string
- project string
- api_
config str - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- gateway_
id 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 str
- project str
- api
Config String - Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
- gateway
Id String - Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
- display
Name 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 String
- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Create
Time string - Created time.
- Default
Hostname 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.
- Update
Time string - Updated time.
- Create
Time string - Created time.
- Default
Hostname 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.
- Update
Time string - Updated time.
- create
Time String - Created time.
- default
Hostname 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.
- update
Time String - Updated time.
- create
Time string - Created time.
- default
Hostname 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.
- update
Time 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.
- create
Time String - Created time.
- default
Hostname 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.
- update
Time 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.