Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.1 published on Tuesday, May 24, 2022 by Pulumi

Gateway

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

Create a Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_config: Optional[str] = None,
            display_name: Optional[str] = None,
            gateway_id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            project: Optional[str] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

The Gateway resource accepts the following input properties:

ApiConfig string

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

GatewayId 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 string
Project string
ApiConfig string

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

GatewayId 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 string
Project string
apiConfig String

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

gatewayId String

Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.

displayName String

Optional. Display name.

labels Map

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
apiConfig string

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

gatewayId 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 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
apiConfig String

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

gatewayId String

Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.

displayName String

Optional. Display name.

labels Map

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:

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0