1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1
  6. AttributeDefinition

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.healthcare/v1.AttributeDefinition

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 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/v1:AttributeDefinition
    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 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.

    Example

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

    var attributeDefinitionResource = new GoogleNative.Healthcare.V1.AttributeDefinition("attributeDefinitionResource", new()
    {
        AllowedValues = new[]
        {
            "string",
        },
        AttributeDefinitionId = "string",
        Category = GoogleNative.Healthcare.V1.AttributeDefinitionCategory.CategoryUnspecified,
        ConsentStoreId = "string",
        DatasetId = "string",
        ConsentDefaultValues = new[]
        {
            "string",
        },
        DataMappingDefaultValue = "string",
        Description = "string",
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := healthcare.NewAttributeDefinition(ctx, "attributeDefinitionResource", &healthcare.AttributeDefinitionArgs{
    AllowedValues: pulumi.StringArray{
    pulumi.String("string"),
    },
    AttributeDefinitionId: pulumi.String("string"),
    Category: healthcare.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"),
    })
    
    var attributeDefinitionResource = new AttributeDefinition("attributeDefinitionResource", AttributeDefinitionArgs.builder()
        .allowedValues("string")
        .attributeDefinitionId("string")
        .category("CATEGORY_UNSPECIFIED")
        .consentStoreId("string")
        .datasetId("string")
        .consentDefaultValues("string")
        .dataMappingDefaultValue("string")
        .description("string")
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    attribute_definition_resource = google_native.healthcare.v1.AttributeDefinition("attributeDefinitionResource",
        allowed_values=["string"],
        attribute_definition_id="string",
        category=google_native.healthcare.v1.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 attributeDefinitionResource = new google_native.healthcare.v1.AttributeDefinition("attributeDefinitionResource", {
        allowedValues: ["string"],
        attributeDefinitionId: "string",
        category: google_native.healthcare.v1.AttributeDefinitionCategory.CategoryUnspecified,
        consentStoreId: "string",
        datasetId: "string",
        consentDefaultValues: ["string"],
        dataMappingDefaultValue: "string",
        description: "string",
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:healthcare/v1: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

    The AttributeDefinition resource accepts the following input properties:

    AllowedValues 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.
    AttributeDefinitionId string
    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.GoogleNative.Healthcare.V1.AttributeDefinitionCategory
    The category of the attribute. The value of this field cannot be changed after creation.
    ConsentStoreId string
    DatasetId string
    ConsentDefaultValues List<string>
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    DataMappingDefaultValue string
    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
    AllowedValues []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.
    AttributeDefinitionId string
    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 AttributeDefinitionCategory
    The category of the attribute. The value of this field cannot be changed after creation.
    ConsentStoreId string
    DatasetId string
    ConsentDefaultValues []string
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    DataMappingDefaultValue string
    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
    allowedValues 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.
    attributeDefinitionId String
    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 AttributeDefinitionCategory
    The category of the attribute. The value of this field cannot be changed after creation.
    consentStoreId String
    datasetId String
    consentDefaultValues List<String>
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    dataMappingDefaultValue String
    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
    allowedValues 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.
    attributeDefinitionId string
    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 AttributeDefinitionCategory
    The category of the attribute. The value of this field cannot be changed after creation.
    consentStoreId string
    datasetId string
    consentDefaultValues string[]
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    dataMappingDefaultValue string
    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_id str
    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 AttributeDefinitionCategory
    The category of the attribute. The value of this field cannot be changed after creation.
    consent_store_id str
    dataset_id str
    consent_default_values Sequence[str]
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    data_mapping_default_value str
    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
    allowedValues 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.
    attributeDefinitionId String
    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.
    consentStoreId String
    datasetId String
    consentDefaultValues List<String>
    Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
    dataMappingDefaultValue String
    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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AttributeDefinitionCategory, AttributeDefinitionCategoryArgs

    CategoryUnspecified
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    Resource
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    Request
    REQUESTSpecify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization.
    AttributeDefinitionCategoryCategoryUnspecified
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    AttributeDefinitionCategoryResource
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    AttributeDefinitionCategoryRequest
    REQUESTSpecify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization.
    CategoryUnspecified
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    Resource
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    Request
    REQUESTSpecify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization.
    CategoryUnspecified
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    Resource
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    Request
    REQUESTSpecify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization.
    CATEGORY_UNSPECIFIED
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    RESOURCE
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    REQUEST
    REQUESTSpecify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization.
    "CATEGORY_UNSPECIFIED"
    CATEGORY_UNSPECIFIEDNo category specified. This option is invalid.
    "RESOURCE"
    RESOURCESpecify this category when this attribute describes the properties of resources. For example, data anonymity or data type.
    "REQUEST"
    REQUESTSpecify 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
    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