1. Packages
  2. Google Cloud Native
  3. API Docs
  4. connectors
  5. connectors/v2
  6. Entity

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

google-native.connectors/v2.Entity

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

    Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a Entity message object returned as a response by the external system. Auto-naming is currently not supported for this resource.

    Create Entity Resource

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

    Constructor syntax

    new Entity(name: string, args: EntityArgs, opts?: CustomResourceOptions);
    @overload
    def Entity(resource_name: str,
               args: EntityArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Entity(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               connection_id: Optional[str] = None,
               entity_type_id: Optional[str] = None,
               fields: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               project: Optional[str] = None)
    func NewEntity(ctx *Context, name string, args EntityArgs, opts ...ResourceOption) (*Entity, error)
    public Entity(string name, EntityArgs args, CustomResourceOptions? opts = null)
    public Entity(String name, EntityArgs args)
    public Entity(String name, EntityArgs args, CustomResourceOptions options)
    
    type: google-native:connectors/v2:Entity
    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 EntityArgs
    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 EntityArgs
    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 EntityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityArgs
    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 entityResource = new GoogleNative.Connectors.V2.Entity("entityResource", new()
    {
        ConnectionId = "string",
        EntityTypeId = "string",
        Fields = 
        {
            { "string", "string" },
        },
        Location = "string",
        Project = "string",
    });
    
    example, err := connectorsv2.NewEntity(ctx, "entityResource", &connectorsv2.EntityArgs{
    ConnectionId: pulumi.String("string"),
    EntityTypeId: pulumi.String("string"),
    Fields: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var entityResource = new Entity("entityResource", EntityArgs.builder()
        .connectionId("string")
        .entityTypeId("string")
        .fields(Map.of("string", "string"))
        .location("string")
        .project("string")
        .build());
    
    entity_resource = google_native.connectors.v2.Entity("entityResource",
        connection_id="string",
        entity_type_id="string",
        fields={
            "string": "string",
        },
        location="string",
        project="string")
    
    const entityResource = new google_native.connectors.v2.Entity("entityResource", {
        connectionId: "string",
        entityTypeId: "string",
        fields: {
            string: "string",
        },
        location: "string",
        project: "string",
    });
    
    type: google-native:connectors/v2:Entity
    properties:
        connectionId: string
        entityTypeId: string
        fields:
            string: string
        location: string
        project: string
    

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

    ConnectionId string
    EntityTypeId string
    Fields Dictionary<string, string>
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    Location string
    Project string
    ConnectionId string
    EntityTypeId string
    Fields map[string]string
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    Location string
    Project string
    connectionId String
    entityTypeId String
    fields Map<String,String>
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    location String
    project String
    connectionId string
    entityTypeId string
    fields {[key: string]: string}
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    location string
    project string
    connection_id str
    entity_type_id str
    fields Mapping[str, str]
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    location str
    project str
    connectionId String
    entityTypeId String
    fields Map<String>
    Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.
    location String
    project String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

    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