Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datastream
  5. datastream/v1
  6. Route

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.datastream/v1.Route

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

Use this method to create a route for a private connectivity configuration in a project and location. Auto-naming is currently not supported for this resource.

Create Route Resource

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

Constructor syntax

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

@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          destination_address: Optional[str] = None,
          display_name: Optional[str] = None,
          private_connection_id: Optional[str] = None,
          route_id: Optional[str] = None,
          destination_port: Optional[int] = None,
          labels: Optional[Mapping[str, str]] = None,
          location: Optional[str] = None,
          project: Optional[str] = None,
          request_id: Optional[str] = None)
func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)

type: google-native:datastream/v1:Route
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. RouteArgs
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. RouteArgs
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. RouteArgs
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. RouteArgs
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. RouteArgs
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 examplerouteResourceResourceFromDatastreamv1 = new GoogleNative.Datastream.V1.Route("examplerouteResourceResourceFromDatastreamv1", new()
{
    DestinationAddress = "string",
    DisplayName = "string",
    PrivateConnectionId = "string",
    RouteId = "string",
    DestinationPort = 0,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
    RequestId = "string",
});
Copy
example, err := datastream.NewRoute(ctx, "examplerouteResourceResourceFromDatastreamv1", &datastream.RouteArgs{
	DestinationAddress:  pulumi.String("string"),
	DisplayName:         pulumi.String("string"),
	PrivateConnectionId: pulumi.String("string"),
	RouteId:             pulumi.String("string"),
	DestinationPort:     pulumi.Int(0),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
})
Copy
var examplerouteResourceResourceFromDatastreamv1 = new Route("examplerouteResourceResourceFromDatastreamv1", RouteArgs.builder()
    .destinationAddress("string")
    .displayName("string")
    .privateConnectionId("string")
    .routeId("string")
    .destinationPort(0)
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .requestId("string")
    .build());
Copy
exampleroute_resource_resource_from_datastreamv1 = google_native.datastream.v1.Route("examplerouteResourceResourceFromDatastreamv1",
    destination_address="string",
    display_name="string",
    private_connection_id="string",
    route_id="string",
    destination_port=0,
    labels={
        "string": "string",
    },
    location="string",
    project="string",
    request_id="string")
Copy
const examplerouteResourceResourceFromDatastreamv1 = new google_native.datastream.v1.Route("examplerouteResourceResourceFromDatastreamv1", {
    destinationAddress: "string",
    displayName: "string",
    privateConnectionId: "string",
    routeId: "string",
    destinationPort: 0,
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
    requestId: "string",
});
Copy
type: google-native:datastream/v1:Route
properties:
    destinationAddress: string
    destinationPort: 0
    displayName: string
    labels:
        string: string
    location: string
    privateConnectionId: string
    project: string
    requestId: string
    routeId: string
Copy

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

DestinationAddress This property is required. string
Destination address for connection
DisplayName This property is required. string
Display name.
PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
RouteId
This property is required.
Changes to this property will trigger replacement.
string
Required. The Route identifier.
DestinationPort int
Destination port for connection
Labels Dictionary<string, string>
Labels.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A 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).
DestinationAddress This property is required. string
Destination address for connection
DisplayName This property is required. string
Display name.
PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
RouteId
This property is required.
Changes to this property will trigger replacement.
string
Required. The Route identifier.
DestinationPort int
Destination port for connection
Labels map[string]string
Labels.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A 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).
destinationAddress This property is required. String
Destination address for connection
displayName This property is required. String
Display name.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
routeId
This property is required.
Changes to this property will trigger replacement.
String
Required. The Route identifier.
destinationPort Integer
Destination port for connection
labels Map<String,String>
Labels.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
requestId String
Optional. A 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).
destinationAddress This property is required. string
Destination address for connection
displayName This property is required. string
Display name.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
routeId
This property is required.
Changes to this property will trigger replacement.
string
Required. The Route identifier.
destinationPort number
Destination port for connection
labels {[key: string]: string}
Labels.
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
requestId string
Optional. A 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).
destination_address This property is required. str
Destination address for connection
display_name This property is required. str
Display name.
private_connection_id
This property is required.
Changes to this property will trigger replacement.
str
route_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The Route identifier.
destination_port int
Destination port for connection
labels Mapping[str, str]
Labels.
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
request_id str
Optional. A 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).
destinationAddress This property is required. String
Destination address for connection
displayName This property is required. String
Display name.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
routeId
This property is required.
Changes to this property will trigger replacement.
String
Required. The Route identifier.
destinationPort Number
Destination port for connection
labels Map<String>
Labels.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
requestId String
Optional. A 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 Route resource produces the following output properties:

CreateTime string
The create time of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource's name.
UpdateTime string
The update time of the resource.
CreateTime string
The create time of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource's name.
UpdateTime string
The update time of the resource.
createTime String
The create time of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource's name.
updateTime String
The update time of the resource.
createTime string
The create time of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource's name.
updateTime string
The update time of the resource.
create_time str
The create time of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource's name.
update_time str
The update time of the resource.
createTime String
The create time of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource's name.
updateTime String
The update time of the resource.

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