This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Creates a new Attribute definition in the parent consent store.
Create AttributeDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AttributeDefinition(name: string, args: AttributeDefinitionArgs, opts?: CustomResourceOptions);@overload
def AttributeDefinition(resource_name: str,
args: AttributeDefinitionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AttributeDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
allowed_values: Optional[Sequence[str]] = None,
attribute_definition_id: Optional[str] = None,
category: Optional[AttributeDefinitionCategory] = None,
consent_store_id: Optional[str] = None,
dataset_id: Optional[str] = None,
consent_default_values: Optional[Sequence[str]] = None,
data_mapping_default_value: Optional[str] = None,
description: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None)func NewAttributeDefinition(ctx *Context, name string, args AttributeDefinitionArgs, opts ...ResourceOption) (*AttributeDefinition, error)public AttributeDefinition(string name, AttributeDefinitionArgs args, CustomResourceOptions? opts = null)
public AttributeDefinition(String name, AttributeDefinitionArgs args)
public AttributeDefinition(String name, AttributeDefinitionArgs args, CustomResourceOptions options)
type: google-native:healthcare/v1beta1:AttributeDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_healthcare_v1beta1_attribute_definition" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AttributeDefinitionArgs
- 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 AttributeDefinitionArgs
- 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 AttributeDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AttributeDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AttributeDefinitionArgs
- 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_nativeAttributeDefinitionResource = new GoogleNative.Healthcare.V1Beta1.AttributeDefinition("google-nativeAttributeDefinitionResource", new()
{
AllowedValues = new[]
{
"string",
},
AttributeDefinitionId = "string",
Category = GoogleNative.Healthcare.V1Beta1.AttributeDefinitionCategory.CategoryUnspecified,
ConsentStoreId = "string",
DatasetId = "string",
ConsentDefaultValues = new[]
{
"string",
},
DataMappingDefaultValue = "string",
Description = "string",
Location = "string",
Name = "string",
Project = "string",
});
example, err := healthcarev1beta1.NewAttributeDefinition(ctx, "google-nativeAttributeDefinitionResource", &healthcarev1beta1.AttributeDefinitionArgs{
AllowedValues: pulumi.StringArray{
pulumi.String("string"),
},
AttributeDefinitionId: pulumi.String("string"),
Category: healthcarev1beta1.AttributeDefinitionCategoryCategoryUnspecified,
ConsentStoreId: pulumi.String("string"),
DatasetId: pulumi.String("string"),
ConsentDefaultValues: pulumi.StringArray{
pulumi.String("string"),
},
DataMappingDefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})
resource "google-native_healthcare_v1beta1_attribute_definition" "google-nativeAttributeDefinitionResource" {
lifecycle {
create_before_destroy = true
}
allowed_values = ["string"]
attribute_definition_id = "string"
category = "CATEGORY_UNSPECIFIED"
consent_store_id = "string"
dataset_id = "string"
consent_default_values = ["string"]
data_mapping_default_value = "string"
description = "string"
location = "string"
name = "string"
project = "string"
}
var google_nativeAttributeDefinitionResource = new com.pulumi.googlenative.healthcare_v1beta1.AttributeDefinition("google-nativeAttributeDefinitionResource", com.pulumi.googlenative.healthcare_v1beta1.AttributeDefinitionArgs.builder()
.allowedValues("string")
.attributeDefinitionId("string")
.category(com.pulumi.googlenative.healthcare_v1beta1.enums.AttributeDefinitionCategory.CategoryUnspecified)
.consentStoreId("string")
.datasetId("string")
.consentDefaultValues("string")
.dataMappingDefaultValue("string")
.description("string")
.location("string")
.name("string")
.project("string")
.build());
google_native_attribute_definition_resource = google_native.healthcare.v1beta1.AttributeDefinition("google-nativeAttributeDefinitionResource",
allowed_values=["string"],
attribute_definition_id="string",
category=google_native.healthcare.v1beta1.AttributeDefinitionCategory.CATEGORY_UNSPECIFIED,
consent_store_id="string",
dataset_id="string",
consent_default_values=["string"],
data_mapping_default_value="string",
description="string",
location="string",
name="string",
project="string")
const google_nativeAttributeDefinitionResource = new google_native.healthcare.v1beta1.AttributeDefinition("google-nativeAttributeDefinitionResource", {
allowedValues: ["string"],
attributeDefinitionId: "string",
category: google_native.healthcare.v1beta1.AttributeDefinitionCategory.CategoryUnspecified,
consentStoreId: "string",
datasetId: "string",
consentDefaultValues: ["string"],
dataMappingDefaultValue: "string",
description: "string",
location: "string",
name: "string",
project: "string",
});
type: google-native:healthcare/v1beta1:AttributeDefinition
properties:
allowedValues:
- string
attributeDefinitionId: string
category: CATEGORY_UNSPECIFIED
consentDefaultValues:
- string
consentStoreId: string
dataMappingDefaultValue: string
datasetId: string
description: string
location: string
name: string
project: string
AttributeDefinition 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 AttributeDefinition resource accepts the following input properties:
- Allowed
Values List<string> - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- Attribute
Definition stringId - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - Category
Pulumi.
Google Native. Healthcare. V1Beta1. Attribute Definition Category - The category of the attribute. The value of this field cannot be changed after creation.
- Consent
Store stringId - Dataset
Id string - Consent
Default List<string>Values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- Data
Mapping stringDefault Value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - Description string
- Optional. A description of the attribute.
- Location string
- Name string
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - Project string
- Allowed
Values []string - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- Attribute
Definition stringId - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - Category
Attribute
Definition Category - The category of the attribute. The value of this field cannot be changed after creation.
- Consent
Store stringId - Dataset
Id string - Consent
Default []stringValues - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- Data
Mapping stringDefault Value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - Description string
- Optional. A description of the attribute.
- Location string
- Name string
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - Project string
- allowed_
values list(string) - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- attribute_
definition_ stringid - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - category "CATEGORY_UNSPECIFIED" | "RESOURCE" | "REQUEST"
- The category of the attribute. The value of this field cannot be changed after creation.
- consent_
store_ stringid - dataset_
id string - consent_
default_ list(string)values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- data_
mapping_ stringdefault_ value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - description string
- Optional. A description of the attribute.
- location string
- name string
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - project string
- allowed
Values List<String> - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- attribute
Definition StringId - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - category
Attribute
Definition Category - The category of the attribute. The value of this field cannot be changed after creation.
- consent
Store StringId - dataset
Id String - consent
Default List<String>Values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- data
Mapping StringDefault Value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - description String
- Optional. A description of the attribute.
- location String
- name String
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - project String
- allowed
Values string[] - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- attribute
Definition stringId - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - category
Attribute
Definition Category - The category of the attribute. The value of this field cannot be changed after creation.
- consent
Store stringId - dataset
Id string - consent
Default string[]Values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- data
Mapping stringDefault Value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - description string
- Optional. A description of the attribute.
- location string
- name string
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - project string
- allowed_
values Sequence[str] - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- attribute_
definition_ strid - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - category
Attribute
Definition Category - The category of the attribute. The value of this field cannot be changed after creation.
- consent_
store_ strid - dataset_
id str - consent_
default_ Sequence[str]values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- data_
mapping_ strdefault_ value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - description str
- Optional. A description of the attribute.
- location str
- name str
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - project str
- allowed
Values List<String> - Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
- attribute
Definition StringId - Required. The ID of the Attribute definition to create. The string must match the following regex:
_a-zA-Z{0,255}and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. - category "CATEGORY_UNSPECIFIED" | "RESOURCE" | "REQUEST"
- The category of the attribute. The value of this field cannot be changed after creation.
- consent
Store StringId - dataset
Id String - consent
Default List<String>Values - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
- data
Mapping StringDefault Value - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category
RESOURCE. - description String
- Optional. A description of the attribute.
- location String
- name String
- Resource name of the Attribute definition, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation. - project String
Outputs
All input properties are implicitly available as output properties. Additionally, the AttributeDefinition resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AttributeDefinition Resource
Get an existing AttributeDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): AttributeDefinition@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> AttributeDefinitionfunc GetAttributeDefinition(ctx *Context, name string, id IDInput, state *AttributeDefinitionState, opts ...ResourceOption) (*AttributeDefinition, error)public static AttributeDefinition Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static AttributeDefinition get(String name, Output<String> id, CustomResourceOptions options)resources: existingAttributeDefinition: type: google-native:healthcare/v1beta1:AttributeDefinition get: id: ${id}import {
to = google-native_healthcare_v1beta1_attribute_definition.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state AttributeDefinitionState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AttributeDefinitionCategory
Required. The category of the attribute. The value of this field cannot be changed after creation.
| Name | Value | Description |
|---|---|---|
| Category | CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
| Resource | RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
| Request | REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Name | Value | Description |
|---|---|---|
| Attribute | CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
| Attribute | RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
| Attribute | REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Value | Description |
|---|---|
CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Name | Value | Description |
|---|---|---|
| Category | CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
| Resource | RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
| Request | REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Name | Value | Description |
|---|---|---|
| Category | CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
| Resource | RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
| Request | REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Name | Value | Description |
|---|---|---|
| CATEGORY_UNSPECIFIED | CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
| RESOURCE | RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
| REQUEST | REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
| Value | Description |
|---|---|
CATEGORY_UNSPECIFIED | No category specified. This option is invalid. |
RESOURCE | Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
REQUEST | Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi