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

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.dataplex/v1.DataAttributeBinding

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

Create a DataAttributeBinding resource. Auto-naming is currently not supported for this resource.

Create DataAttributeBinding Resource

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

Constructor syntax

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

@overload
def DataAttributeBinding(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data_attribute_binding_id: Optional[str] = None,
                         attributes: Optional[Sequence[str]] = None,
                         description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         etag: Optional[str] = None,
                         labels: Optional[Mapping[str, str]] = None,
                         location: Optional[str] = None,
                         paths: Optional[Sequence[GoogleCloudDataplexV1DataAttributeBindingPathArgs]] = None,
                         project: Optional[str] = None,
                         resource: Optional[str] = None)
func NewDataAttributeBinding(ctx *Context, name string, args DataAttributeBindingArgs, opts ...ResourceOption) (*DataAttributeBinding, error)
public DataAttributeBinding(string name, DataAttributeBindingArgs args, CustomResourceOptions? opts = null)
public DataAttributeBinding(String name, DataAttributeBindingArgs args)
public DataAttributeBinding(String name, DataAttributeBindingArgs args, CustomResourceOptions options)

type: google-native:dataplex/v1:DataAttributeBinding
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. DataAttributeBindingArgs
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. DataAttributeBindingArgs
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. DataAttributeBindingArgs
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. DataAttributeBindingArgs
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. DataAttributeBindingArgs
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 dataAttributeBindingResource = new GoogleNative.Dataplex.V1.DataAttributeBinding("dataAttributeBindingResource", new()
{
    DataAttributeBindingId = "string",
    Attributes = new[]
    {
        "string",
    },
    Description = "string",
    DisplayName = "string",
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Paths = new[]
    {
        new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataAttributeBindingPathArgs
        {
            Name = "string",
            Attributes = new[]
            {
                "string",
            },
        },
    },
    Project = "string",
    Resource = "string",
});
Copy
example, err := dataplex.NewDataAttributeBinding(ctx, "dataAttributeBindingResource", &dataplex.DataAttributeBindingArgs{
	DataAttributeBindingId: pulumi.String("string"),
	Attributes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Etag:        pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Paths: dataplex.GoogleCloudDataplexV1DataAttributeBindingPathArray{
		&dataplex.GoogleCloudDataplexV1DataAttributeBindingPathArgs{
			Name: pulumi.String("string"),
			Attributes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Project:  pulumi.String("string"),
	Resource: pulumi.String("string"),
})
Copy
var dataAttributeBindingResource = new DataAttributeBinding("dataAttributeBindingResource", DataAttributeBindingArgs.builder()
    .dataAttributeBindingId("string")
    .attributes("string")
    .description("string")
    .displayName("string")
    .etag("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .paths(GoogleCloudDataplexV1DataAttributeBindingPathArgs.builder()
        .name("string")
        .attributes("string")
        .build())
    .project("string")
    .resource("string")
    .build());
Copy
data_attribute_binding_resource = google_native.dataplex.v1.DataAttributeBinding("dataAttributeBindingResource",
    data_attribute_binding_id="string",
    attributes=["string"],
    description="string",
    display_name="string",
    etag="string",
    labels={
        "string": "string",
    },
    location="string",
    paths=[{
        "name": "string",
        "attributes": ["string"],
    }],
    project="string",
    resource="string")
Copy
const dataAttributeBindingResource = new google_native.dataplex.v1.DataAttributeBinding("dataAttributeBindingResource", {
    dataAttributeBindingId: "string",
    attributes: ["string"],
    description: "string",
    displayName: "string",
    etag: "string",
    labels: {
        string: "string",
    },
    location: "string",
    paths: [{
        name: "string",
        attributes: ["string"],
    }],
    project: "string",
    resource: "string",
});
Copy
type: google-native:dataplex/v1:DataAttributeBinding
properties:
    attributes:
        - string
    dataAttributeBindingId: string
    description: string
    displayName: string
    etag: string
    labels:
        string: string
    location: string
    paths:
        - attributes:
            - string
          name: string
    project: string
    resource: string
Copy

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

DataAttributeBindingId
This property is required.
Changes to this property will trigger replacement.
string
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
Attributes List<string>
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Description string
Optional. Description of the DataAttributeBinding.
DisplayName string
Optional. User friendly display name.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
Labels Dictionary<string, string>
Optional. User-defined labels for the DataAttributeBinding.
Location Changes to this property will trigger replacement. string
Paths List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataAttributeBindingPath>
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
Project Changes to this property will trigger replacement. string
Resource string
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
DataAttributeBindingId
This property is required.
Changes to this property will trigger replacement.
string
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
Attributes []string
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Description string
Optional. Description of the DataAttributeBinding.
DisplayName string
Optional. User friendly display name.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
Labels map[string]string
Optional. User-defined labels for the DataAttributeBinding.
Location Changes to this property will trigger replacement. string
Paths []GoogleCloudDataplexV1DataAttributeBindingPathArgs
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
Project Changes to this property will trigger replacement. string
Resource string
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
dataAttributeBindingId
This property is required.
Changes to this property will trigger replacement.
String
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
attributes List<String>
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description String
Optional. Description of the DataAttributeBinding.
displayName String
Optional. User friendly display name.
etag String
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
labels Map<String,String>
Optional. User-defined labels for the DataAttributeBinding.
location Changes to this property will trigger replacement. String
paths List<GoogleCloudDataplexV1DataAttributeBindingPath>
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
project Changes to this property will trigger replacement. String
resource String
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
dataAttributeBindingId
This property is required.
Changes to this property will trigger replacement.
string
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
attributes string[]
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description string
Optional. Description of the DataAttributeBinding.
displayName string
Optional. User friendly display name.
etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
labels {[key: string]: string}
Optional. User-defined labels for the DataAttributeBinding.
location Changes to this property will trigger replacement. string
paths GoogleCloudDataplexV1DataAttributeBindingPath[]
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
project Changes to this property will trigger replacement. string
resource string
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
data_attribute_binding_id
This property is required.
Changes to this property will trigger replacement.
str
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
attributes Sequence[str]
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description str
Optional. Description of the DataAttributeBinding.
display_name str
Optional. User friendly display name.
etag str
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
labels Mapping[str, str]
Optional. User-defined labels for the DataAttributeBinding.
location Changes to this property will trigger replacement. str
paths Sequence[GoogleCloudDataplexV1DataAttributeBindingPathArgs]
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
project Changes to this property will trigger replacement. str
resource str
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
dataAttributeBindingId
This property is required.
Changes to this property will trigger replacement.
String
Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
attributes List<String>
Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description String
Optional. Description of the DataAttributeBinding.
displayName String
Optional. User friendly display name.
etag String
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
labels Map<String>
Optional. User-defined labels for the DataAttributeBinding.
location Changes to this property will trigger replacement. String
paths List<Property Map>
Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
project Changes to this property will trigger replacement. String
resource String
Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.

Outputs

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

CreateTime string
The time when the DataAttributeBinding was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
Uid string
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
UpdateTime string
The time when the DataAttributeBinding was last updated.
CreateTime string
The time when the DataAttributeBinding was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
Uid string
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
UpdateTime string
The time when the DataAttributeBinding was last updated.
createTime String
The time when the DataAttributeBinding was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
uid String
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
updateTime String
The time when the DataAttributeBinding was last updated.
createTime string
The time when the DataAttributeBinding was created.
id string
The provider-assigned unique ID for this managed resource.
name string
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
uid string
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
updateTime string
The time when the DataAttributeBinding was last updated.
create_time str
The time when the DataAttributeBinding was created.
id str
The provider-assigned unique ID for this managed resource.
name str
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
uid str
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
update_time str
The time when the DataAttributeBinding was last updated.
createTime String
The time when the DataAttributeBinding was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
uid String
System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
updateTime String
The time when the DataAttributeBinding was last updated.

Supporting Types

GoogleCloudDataplexV1DataAttributeBindingPath
, GoogleCloudDataplexV1DataAttributeBindingPathArgs

Name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
Attributes List<string>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
Attributes []string
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. String
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes List<String>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes string[]
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. str
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes Sequence[str]
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. String
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes List<String>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

GoogleCloudDataplexV1DataAttributeBindingPathResponse
, GoogleCloudDataplexV1DataAttributeBindingPathResponseArgs

Attributes This property is required. List<string>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
Attributes This property is required. []string
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes This property is required. List<String>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. String
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes This property is required. string[]
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. string
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes This property is required. Sequence[str]
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. str
The name identifier of the path. Nested columns should be of the form: 'address.city'.
attributes This property is required. List<String>
Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
name This property is required. String
The name identifier of the path. Nested columns should be of the form: 'address.city'.

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