Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. connectors
  5. connectors/v1
  6. CustomConnector

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.connectors/v1.CustomConnector

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

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

    Create CustomConnector Resource

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

    Constructor syntax

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

@overload
def CustomConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    custom_connector_id: Optional[str] = None,
                    custom_connector_type: Optional[CustomConnectorCustomConnectorType] = None,
                    description: Optional[str] = None,
                    display_name: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    logo: Optional[str] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None)
    func NewCustomConnector(ctx *Context, name string, args CustomConnectorArgs, opts ...ResourceOption) (*CustomConnector, error)
    public CustomConnector(string name, CustomConnectorArgs args, CustomResourceOptions? opts = null)
    public CustomConnector(String name, CustomConnectorArgs args)
public CustomConnector(String name, CustomConnectorArgs args, CustomResourceOptions options)

    type: google-native:connectors/v1:CustomConnector
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 CustomConnectorArgs
    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 CustomConnectorArgs
    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 CustomConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var customConnectorResource = new GoogleNative.Connectors.V1.CustomConnector("customConnectorResource", new()
{
    CustomConnectorId = "string",
    CustomConnectorType = GoogleNative.Connectors.V1.CustomConnectorCustomConnectorType.CustomConnectorTypeUnspecified,
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Logo = "string",
    Name = "string",
    Project = "string",
});

    example, err := connectors.NewCustomConnector(ctx, "customConnectorResource", &connectors.CustomConnectorArgs{
CustomConnectorId: pulumi.String("string"),
CustomConnectorType: connectors.CustomConnectorCustomConnectorTypeCustomConnectorTypeUnspecified,
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Logo: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})

    var customConnectorResource = new CustomConnector("customConnectorResource", CustomConnectorArgs.builder()        
    .customConnectorId("string")
    .customConnectorType("CUSTOM_CONNECTOR_TYPE_UNSPECIFIED")
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .logo("string")
    .name("string")
    .project("string")
    .build());

    custom_connector_resource = google_native.connectors.v1.CustomConnector("customConnectorResource",
    custom_connector_id="string",
    custom_connector_type=google_native.connectors.v1.CustomConnectorCustomConnectorType.CUSTOM_CONNECTOR_TYPE_UNSPECIFIED,
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    logo="string",
    name="string",
    project="string")

    const customConnectorResource = new google_native.connectors.v1.CustomConnector("customConnectorResource", {
    customConnectorId: "string",
    customConnectorType: google_native.connectors.v1.CustomConnectorCustomConnectorType.CustomConnectorTypeUnspecified,
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    logo: "string",
    name: "string",
    project: "string",
});

    type: google-native:connectors/v1:CustomConnector
properties:
    customConnectorId: string
    customConnectorType: CUSTOM_CONNECTOR_TYPE_UNSPECIFIED
    description: string
    displayName: string
    labels:
        string: string
    logo: string
    name: string
    project: string

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

    CustomConnectorId string
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    CustomConnectorType Pulumi.GoogleNative.Connectors.V1.CustomConnectorCustomConnectorType
    Type of the custom connector.
    Description string
    Optional. Description of the 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
    Logo string
    Optional. Logo of the resource.
    Name string
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    Project string
    CustomConnectorId string
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    CustomConnectorType CustomConnectorCustomConnectorType
    Type of the custom connector.
    Description string
    Optional. Description of the 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
    Logo string
    Optional. Logo of the resource.
    Name string
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    Project string
    customConnectorId String
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    customConnectorType CustomConnectorCustomConnectorType
    Type of the custom connector.
    description String
    Optional. Description of the 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
    logo String
    Optional. Logo of the resource.
    name String
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    project String
    customConnectorId string
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    customConnectorType CustomConnectorCustomConnectorType
    Type of the custom connector.
    description string
    Optional. Description of the 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
    logo string
    Optional. Logo of the resource.
    name string
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    project string
    custom_connector_id str
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    custom_connector_type CustomConnectorCustomConnectorType
    Type of the custom connector.
    description str
    Optional. Description of the 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
    logo str
    Optional. Logo of the resource.
    name str
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    project str
    customConnectorId String
    Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
    customConnectorType "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED" | "OPEN_API" | "PROTO"
    Type of the custom connector.
    description String
    Optional. Description of the 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
    logo String
    Optional. Logo of the resource.
    name String
    Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
    project String

    Outputs

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

    CreateTime string
    Created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LaunchStage string
    Launch stage.
    UpdateTime string
    Updated time.
    CreateTime string
    Created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LaunchStage string
    Launch stage.
    UpdateTime string
    Updated time.
    createTime String
    Created time.
    id String
    The provider-assigned unique ID for this managed resource.
    launchStage String
    Launch stage.
    updateTime String
    Updated time.
    createTime string
    Created time.
    id string
    The provider-assigned unique ID for this managed resource.
    launchStage string
    Launch stage.
    updateTime string
    Updated time.
    create_time str
    Created time.
    id str
    The provider-assigned unique ID for this managed resource.
    launch_stage str
    Launch stage.
    update_time str
    Updated time.
    createTime String
    Created time.
    id String
    The provider-assigned unique ID for this managed resource.
    launchStage String
    Launch stage.
    updateTime String
    Updated time.

    Supporting Types

    CustomConnectorCustomConnectorType, CustomConnectorCustomConnectorTypeArgs

    CustomConnectorTypeUnspecified
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    OpenApi
    OPEN_APIOpenAPI connector.
    Proto
    PROTOProto connector.
    CustomConnectorCustomConnectorTypeCustomConnectorTypeUnspecified
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    CustomConnectorCustomConnectorTypeOpenApi
    OPEN_APIOpenAPI connector.
    CustomConnectorCustomConnectorTypeProto
    PROTOProto connector.
    CustomConnectorTypeUnspecified
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    OpenApi
    OPEN_APIOpenAPI connector.
    Proto
    PROTOProto connector.
    CustomConnectorTypeUnspecified
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    OpenApi
    OPEN_APIOpenAPI connector.
    Proto
    PROTOProto connector.
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIED
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    OPEN_API
    OPEN_APIOpenAPI connector.
    PROTO
    PROTOProto connector.
    "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED"
    CUSTOM_CONNECTOR_TYPE_UNSPECIFIEDConnector type is not specified.
    "OPEN_API"
    OPEN_APIOpenAPI connector.
    "PROTO"
    PROTOProto connector.

    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