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

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.ConsentArtifact

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 Consent artifact in the parent consent store.

    Create ConsentArtifact Resource

    new ConsentArtifact(name: string, args: ConsentArtifactArgs, opts?: CustomResourceOptions);
    @overload
    def ConsentArtifact(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        consent_content_screenshots: Optional[Sequence[ImageArgs]] = None,
                        consent_content_version: Optional[str] = None,
                        consent_store_id: Optional[str] = None,
                        dataset_id: Optional[str] = None,
                        guardian_signature: Optional[SignatureArgs] = None,
                        location: Optional[str] = None,
                        metadata: Optional[Mapping[str, str]] = None,
                        name: Optional[str] = None,
                        project: Optional[str] = None,
                        user_id: Optional[str] = None,
                        user_signature: Optional[SignatureArgs] = None,
                        witness_signature: Optional[SignatureArgs] = None)
    @overload
    def ConsentArtifact(resource_name: str,
                        args: ConsentArtifactArgs,
                        opts: Optional[ResourceOptions] = None)
    func NewConsentArtifact(ctx *Context, name string, args ConsentArtifactArgs, opts ...ResourceOption) (*ConsentArtifact, error)
    public ConsentArtifact(string name, ConsentArtifactArgs args, CustomResourceOptions? opts = null)
    public ConsentArtifact(String name, ConsentArtifactArgs args)
    public ConsentArtifact(String name, ConsentArtifactArgs args, CustomResourceOptions options)
    
    type: google-native:healthcare/v1:ConsentArtifact
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ConsentArtifactArgs
    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 ConsentArtifactArgs
    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 ConsentArtifactArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsentArtifactArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsentArtifactArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ConsentStoreId string
    DatasetId string
    UserId string
    User's UUID provided by the client.
    ConsentContentScreenshots List<Pulumi.GoogleNative.Healthcare.V1.Inputs.Image>
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    ConsentContentVersion string
    Optional. An string indicating the version of the consent information shown to the user.
    GuardianSignature Pulumi.GoogleNative.Healthcare.V1.Inputs.Signature
    Optional. A signature from a guardian.
    Location string
    Metadata Dictionary<string, string>
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    Name string
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    Project string
    UserSignature Pulumi.GoogleNative.Healthcare.V1.Inputs.Signature
    Optional. User's signature.
    WitnessSignature Pulumi.GoogleNative.Healthcare.V1.Inputs.Signature
    Optional. A signature from a witness.
    ConsentStoreId string
    DatasetId string
    UserId string
    User's UUID provided by the client.
    ConsentContentScreenshots []ImageArgs
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    ConsentContentVersion string
    Optional. An string indicating the version of the consent information shown to the user.
    GuardianSignature SignatureArgs
    Optional. A signature from a guardian.
    Location string
    Metadata map[string]string
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    Name string
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    Project string
    UserSignature SignatureArgs
    Optional. User's signature.
    WitnessSignature SignatureArgs
    Optional. A signature from a witness.
    consentStoreId String
    datasetId String
    userId String
    User's UUID provided by the client.
    consentContentScreenshots List<Image>
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    consentContentVersion String
    Optional. An string indicating the version of the consent information shown to the user.
    guardianSignature Signature
    Optional. A signature from a guardian.
    location String
    metadata Map<String,String>
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    name String
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    project String
    userSignature Signature
    Optional. User's signature.
    witnessSignature Signature
    Optional. A signature from a witness.
    consentStoreId string
    datasetId string
    userId string
    User's UUID provided by the client.
    consentContentScreenshots Image[]
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    consentContentVersion string
    Optional. An string indicating the version of the consent information shown to the user.
    guardianSignature Signature
    Optional. A signature from a guardian.
    location string
    metadata {[key: string]: string}
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    name string
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    project string
    userSignature Signature
    Optional. User's signature.
    witnessSignature Signature
    Optional. A signature from a witness.
    consent_store_id str
    dataset_id str
    user_id str
    User's UUID provided by the client.
    consent_content_screenshots Sequence[ImageArgs]
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    consent_content_version str
    Optional. An string indicating the version of the consent information shown to the user.
    guardian_signature SignatureArgs
    Optional. A signature from a guardian.
    location str
    metadata Mapping[str, str]
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    name str
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    project str
    user_signature SignatureArgs
    Optional. User's signature.
    witness_signature SignatureArgs
    Optional. A signature from a witness.
    consentStoreId String
    datasetId String
    userId String
    User's UUID provided by the client.
    consentContentScreenshots List<Property Map>
    Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    consentContentVersion String
    Optional. An string indicating the version of the consent information shown to the user.
    guardianSignature Property Map
    Optional. A signature from a guardian.
    location String
    metadata Map<String>
    Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    name String
    Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
    project String
    userSignature Property Map
    Optional. User's signature.
    witnessSignature Property Map
    Optional. A signature from a witness.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsentArtifact 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

    Image, ImageArgs

    GcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    RawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    GcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    RawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri String
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes String
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcs_uri str
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    raw_bytes str
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri String
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes String
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.

    ImageResponse, ImageResponseArgs

    GcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    RawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    GcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    RawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri String
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes String
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri string
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes string
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcs_uri str
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    raw_bytes str
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    gcsUri String
    Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    rawBytes String
    Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.

    Signature, SignatureArgs

    UserId string
    User's UUID provided by the client.
    Image Pulumi.GoogleNative.Healthcare.V1.Inputs.Image
    Optional. An image of the user's signature.
    Metadata Dictionary<string, string>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    SignatureTime string
    Optional. Timestamp of the signature.
    UserId string
    User's UUID provided by the client.
    Image Image
    Optional. An image of the user's signature.
    Metadata map[string]string
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    SignatureTime string
    Optional. Timestamp of the signature.
    userId String
    User's UUID provided by the client.
    image Image
    Optional. An image of the user's signature.
    metadata Map<String,String>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime String
    Optional. Timestamp of the signature.
    userId string
    User's UUID provided by the client.
    image Image
    Optional. An image of the user's signature.
    metadata {[key: string]: string}
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime string
    Optional. Timestamp of the signature.
    user_id str
    User's UUID provided by the client.
    image Image
    Optional. An image of the user's signature.
    metadata Mapping[str, str]
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signature_time str
    Optional. Timestamp of the signature.
    userId String
    User's UUID provided by the client.
    image Property Map
    Optional. An image of the user's signature.
    metadata Map<String>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime String
    Optional. Timestamp of the signature.

    SignatureResponse, SignatureResponseArgs

    Image Pulumi.GoogleNative.Healthcare.V1.Inputs.ImageResponse
    Optional. An image of the user's signature.
    Metadata Dictionary<string, string>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    SignatureTime string
    Optional. Timestamp of the signature.
    UserId string
    User's UUID provided by the client.
    Image ImageResponse
    Optional. An image of the user's signature.
    Metadata map[string]string
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    SignatureTime string
    Optional. Timestamp of the signature.
    UserId string
    User's UUID provided by the client.
    image ImageResponse
    Optional. An image of the user's signature.
    metadata Map<String,String>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime String
    Optional. Timestamp of the signature.
    userId String
    User's UUID provided by the client.
    image ImageResponse
    Optional. An image of the user's signature.
    metadata {[key: string]: string}
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime string
    Optional. Timestamp of the signature.
    userId string
    User's UUID provided by the client.
    image ImageResponse
    Optional. An image of the user's signature.
    metadata Mapping[str, str]
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signature_time str
    Optional. Timestamp of the signature.
    user_id str
    User's UUID provided by the client.
    image Property Map
    Optional. An image of the user's signature.
    metadata Map<String>
    Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    signatureTime String
    Optional. Timestamp of the signature.
    userId String
    User's UUID provided by the client.

    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