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

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.PrivateConnection

Explore with Pulumi AI

google-native logo

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 private connectivity configuration. Auto-naming is currently not supported for this resource.

    Create PrivateConnection Resource

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

    Constructor syntax

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

@overload
def PrivateConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      private_connection_id: Optional[str] = None,
                      force: Optional[bool] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: Optional[str] = None,
                      project: Optional[str] = None,
                      request_id: Optional[str] = None,
                      vpc_peering_config: Optional[VpcPeeringConfigArgs] = None)
    func NewPrivateConnection(ctx *Context, name string, args PrivateConnectionArgs, opts ...ResourceOption) (*PrivateConnection, error)
    public PrivateConnection(string name, PrivateConnectionArgs args, CustomResourceOptions? opts = null)
    public PrivateConnection(String name, PrivateConnectionArgs args)
public PrivateConnection(String name, PrivateConnectionArgs args, CustomResourceOptions options)

    type: google-native:datastream/v1:PrivateConnection
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 PrivateConnectionArgs
    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 PrivateConnectionArgs
    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 PrivateConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateConnectionArgs
    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_nativePrivateConnectionResource = new GoogleNative.Datastream.V1.PrivateConnection("google-nativePrivateConnectionResource", new()
{
    DisplayName = "string",
    PrivateConnectionId = "string",
    Force = false,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
    RequestId = "string",
    VpcPeeringConfig = new GoogleNative.Datastream.V1.Inputs.VpcPeeringConfigArgs
    {
        Subnet = "string",
        Vpc = "string",
    },
});

    example, err := datastream.NewPrivateConnection(ctx, "google-nativePrivateConnectionResource", &datastream.PrivateConnectionArgs{
	DisplayName:         pulumi.String("string"),
	PrivateConnectionId: pulumi.String("string"),
	Force:               pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
	VpcPeeringConfig: &datastream.VpcPeeringConfigArgs{
		Subnet: pulumi.String("string"),
		Vpc:    pulumi.String("string"),
	},
})

    var google_nativePrivateConnectionResource = new PrivateConnection("google-nativePrivateConnectionResource", PrivateConnectionArgs.builder()
    .displayName("string")
    .privateConnectionId("string")
    .force(false)
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .requestId("string")
    .vpcPeeringConfig(VpcPeeringConfigArgs.builder()
        .subnet("string")
        .vpc("string")
        .build())
    .build());

    google_native_private_connection_resource = google_native.datastream.v1.PrivateConnection("google-nativePrivateConnectionResource",
    display_name="string",
    private_connection_id="string",
    force=False,
    labels={
        "string": "string",
    },
    location="string",
    project="string",
    request_id="string",
    vpc_peering_config={
        "subnet": "string",
        "vpc": "string",
    })

    const google_nativePrivateConnectionResource = new google_native.datastream.v1.PrivateConnection("google-nativePrivateConnectionResource", {
    displayName: "string",
    privateConnectionId: "string",
    force: false,
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
    requestId: "string",
    vpcPeeringConfig: {
        subnet: "string",
        vpc: "string",
    },
});

    type: google-native:datastream/v1:PrivateConnection
properties:
    displayName: string
    force: false
    labels:
        string: string
    location: string
    privateConnectionId: string
    project: string
    requestId: string
    vpcPeeringConfig:
        subnet: string
        vpc: string

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

    DisplayName string
    Display name.
    PrivateConnectionId string
    Required. The private connectivity identifier.
    Force bool
    Optional. If set to true, will skip validations.
    Labels Dictionary<string, string>
    Labels.
    Location string
    Project 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).
    VpcPeeringConfig Pulumi.GoogleNative.Datastream.V1.Inputs.VpcPeeringConfig
    VPC Peering Config.
    DisplayName string
    Display name.
    PrivateConnectionId string
    Required. The private connectivity identifier.
    Force bool
    Optional. If set to true, will skip validations.
    Labels map[string]string
    Labels.
    Location string
    Project 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).
    VpcPeeringConfig VpcPeeringConfigArgs
    VPC Peering Config.
    displayName String
    Display name.
    privateConnectionId String
    Required. The private connectivity identifier.
    force Boolean
    Optional. If set to true, will skip validations.
    labels Map<String,String>
    Labels.
    location String
    project 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).
    vpcPeeringConfig VpcPeeringConfig
    VPC Peering Config.
    displayName string
    Display name.
    privateConnectionId string
    Required. The private connectivity identifier.
    force boolean
    Optional. If set to true, will skip validations.
    labels {[key: string]: string}
    Labels.
    location string
    project 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).
    vpcPeeringConfig VpcPeeringConfig
    VPC Peering Config.
    display_name str
    Display name.
    private_connection_id str
    Required. The private connectivity identifier.
    force bool
    Optional. If set to true, will skip validations.
    labels Mapping[str, str]
    Labels.
    location str
    project 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).
    vpc_peering_config VpcPeeringConfigArgs
    VPC Peering Config.
    displayName String
    Display name.
    privateConnectionId String
    Required. The private connectivity identifier.
    force Boolean
    Optional. If set to true, will skip validations.
    labels Map<String>
    Labels.
    location String
    project 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).
    vpcPeeringConfig Property Map
    VPC Peering Config.

    Outputs

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

    CreateTime string
    The create time of the resource.
    Error Pulumi.GoogleNative.Datastream.V1.Outputs.ErrorResponse
    In case of error, the details of the error in a user-friendly format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource's name.
    State string
    The state of the Private Connection.
    UpdateTime string
    The update time of the resource.
    CreateTime string
    The create time of the resource.
    Error ErrorResponse
    In case of error, the details of the error in a user-friendly format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource's name.
    State string
    The state of the Private Connection.
    UpdateTime string
    The update time of the resource.
    createTime String
    The create time of the resource.
    error ErrorResponse
    In case of error, the details of the error in a user-friendly format.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource's name.
    state String
    The state of the Private Connection.
    updateTime String
    The update time of the resource.
    createTime string
    The create time of the resource.
    error ErrorResponse
    In case of error, the details of the error in a user-friendly format.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource's name.
    state string
    The state of the Private Connection.
    updateTime string
    The update time of the resource.
    create_time str
    The create time of the resource.
    error ErrorResponse
    In case of error, the details of the error in a user-friendly format.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource's name.
    state str
    The state of the Private Connection.
    update_time str
    The update time of the resource.
    createTime String
    The create time of the resource.
    error Property Map
    In case of error, the details of the error in a user-friendly format.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource's name.
    state String
    The state of the Private Connection.
    updateTime String
    The update time of the resource.

    Supporting Types

    ErrorResponse, ErrorResponseArgs

    Details Dictionary<string, string>
    Additional information about the error.
    ErrorTime string
    The time when the error occurred.
    ErrorUuid string
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    Message string
    A message containing more information about the error that occurred.
    Reason string
    A title that explains the reason for the error.
    Details map[string]string
    Additional information about the error.
    ErrorTime string
    The time when the error occurred.
    ErrorUuid string
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    Message string
    A message containing more information about the error that occurred.
    Reason string
    A title that explains the reason for the error.
    details Map<String,String>
    Additional information about the error.
    errorTime String
    The time when the error occurred.
    errorUuid String
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    message String
    A message containing more information about the error that occurred.
    reason String
    A title that explains the reason for the error.
    details {[key: string]: string}
    Additional information about the error.
    errorTime string
    The time when the error occurred.
    errorUuid string
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    message string
    A message containing more information about the error that occurred.
    reason string
    A title that explains the reason for the error.
    details Mapping[str, str]
    Additional information about the error.
    error_time str
    The time when the error occurred.
    error_uuid str
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    message str
    A message containing more information about the error that occurred.
    reason str
    A title that explains the reason for the error.
    details Map<String>
    Additional information about the error.
    errorTime String
    The time when the error occurred.
    errorUuid String
    A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
    message String
    A message containing more information about the error that occurred.
    reason String
    A title that explains the reason for the error.

    VpcPeeringConfig, VpcPeeringConfigArgs

    Subnet string
    A free subnet for peering. (CIDR of /29)
    Vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    Subnet string
    A free subnet for peering. (CIDR of /29)
    Vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet String
    A free subnet for peering. (CIDR of /29)
    vpc String
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet string
    A free subnet for peering. (CIDR of /29)
    vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet str
    A free subnet for peering. (CIDR of /29)
    vpc str
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet String
    A free subnet for peering. (CIDR of /29)
    vpc String
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}

    VpcPeeringConfigResponse, VpcPeeringConfigResponseArgs

    Subnet string
    A free subnet for peering. (CIDR of /29)
    Vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    Subnet string
    A free subnet for peering. (CIDR of /29)
    Vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet String
    A free subnet for peering. (CIDR of /29)
    vpc String
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet string
    A free subnet for peering. (CIDR of /29)
    vpc string
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet str
    A free subnet for peering. (CIDR of /29)
    vpc str
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}
    subnet String
    A free subnet for peering. (CIDR of /29)
    vpc String
    Fully qualified name of the VPC that Datastream will peer to. Format: projects/{project}/global/{networks}/{name}

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    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