1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. containeranalysis
  5. Note
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

gcp.containeranalysis.Note

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

    A Container Analysis note is a high-level piece of metadata that describes a type of analysis that can be done for a resource.

    To get more information about Note, see:

    Example Usage

    Container Analysis Note Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const note = new gcp.containeranalysis.Note("note", {
        name: "attestor-note",
        attestationAuthority: {
            hint: {
                humanReadableName: "Attestor Note",
            },
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    note = gcp.containeranalysis.Note("note",
        name="attestor-note",
        attestation_authority=gcp.containeranalysis.NoteAttestationAuthorityArgs(
            hint=gcp.containeranalysis.NoteAttestationAuthorityHintArgs(
                human_readable_name="Attestor Note",
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/containeranalysis"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := containeranalysis.NewNote(ctx, "note", &containeranalysis.NoteArgs{
    			Name: pulumi.String("attestor-note"),
    			AttestationAuthority: &containeranalysis.NoteAttestationAuthorityArgs{
    				Hint: &containeranalysis.NoteAttestationAuthorityHintArgs{
    					HumanReadableName: pulumi.String("Attestor Note"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var note = new Gcp.ContainerAnalysis.Note("note", new()
        {
            Name = "attestor-note",
            AttestationAuthority = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityArgs
            {
                Hint = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityHintArgs
                {
                    HumanReadableName = "Attestor Note",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.containeranalysis.Note;
    import com.pulumi.gcp.containeranalysis.NoteArgs;
    import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityArgs;
    import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityHintArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var note = new Note("note", NoteArgs.builder()
                .name("attestor-note")
                .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                    .hint(NoteAttestationAuthorityHintArgs.builder()
                        .humanReadableName("Attestor Note")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      note:
        type: gcp:containeranalysis:Note
        properties:
          name: attestor-note
          attestationAuthority:
            hint:
              humanReadableName: Attestor Note
    

    Container Analysis Note Attestation Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const note = new gcp.containeranalysis.Note("note", {
        name: "attestor-note",
        shortDescription: "test note",
        longDescription: "a longer description of test note",
        expirationTime: "2120-10-02T15:01:23.045123456Z",
        relatedUrls: [
            {
                url: "some.url",
                label: "foo",
            },
            {
                url: "google.com",
            },
        ],
        attestationAuthority: {
            hint: {
                humanReadableName: "Attestor Note",
            },
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    note = gcp.containeranalysis.Note("note",
        name="attestor-note",
        short_description="test note",
        long_description="a longer description of test note",
        expiration_time="2120-10-02T15:01:23.045123456Z",
        related_urls=[
            gcp.containeranalysis.NoteRelatedUrlArgs(
                url="some.url",
                label="foo",
            ),
            gcp.containeranalysis.NoteRelatedUrlArgs(
                url="google.com",
            ),
        ],
        attestation_authority=gcp.containeranalysis.NoteAttestationAuthorityArgs(
            hint=gcp.containeranalysis.NoteAttestationAuthorityHintArgs(
                human_readable_name="Attestor Note",
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/containeranalysis"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := containeranalysis.NewNote(ctx, "note", &containeranalysis.NoteArgs{
    			Name:             pulumi.String("attestor-note"),
    			ShortDescription: pulumi.String("test note"),
    			LongDescription:  pulumi.String("a longer description of test note"),
    			ExpirationTime:   pulumi.String("2120-10-02T15:01:23.045123456Z"),
    			RelatedUrls: containeranalysis.NoteRelatedUrlArray{
    				&containeranalysis.NoteRelatedUrlArgs{
    					Url:   pulumi.String("some.url"),
    					Label: pulumi.String("foo"),
    				},
    				&containeranalysis.NoteRelatedUrlArgs{
    					Url: pulumi.String("google.com"),
    				},
    			},
    			AttestationAuthority: &containeranalysis.NoteAttestationAuthorityArgs{
    				Hint: &containeranalysis.NoteAttestationAuthorityHintArgs{
    					HumanReadableName: pulumi.String("Attestor Note"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var note = new Gcp.ContainerAnalysis.Note("note", new()
        {
            Name = "attestor-note",
            ShortDescription = "test note",
            LongDescription = "a longer description of test note",
            ExpirationTime = "2120-10-02T15:01:23.045123456Z",
            RelatedUrls = new[]
            {
                new Gcp.ContainerAnalysis.Inputs.NoteRelatedUrlArgs
                {
                    Url = "some.url",
                    Label = "foo",
                },
                new Gcp.ContainerAnalysis.Inputs.NoteRelatedUrlArgs
                {
                    Url = "google.com",
                },
            },
            AttestationAuthority = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityArgs
            {
                Hint = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityHintArgs
                {
                    HumanReadableName = "Attestor Note",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.containeranalysis.Note;
    import com.pulumi.gcp.containeranalysis.NoteArgs;
    import com.pulumi.gcp.containeranalysis.inputs.NoteRelatedUrlArgs;
    import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityArgs;
    import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityHintArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var note = new Note("note", NoteArgs.builder()
                .name("attestor-note")
                .shortDescription("test note")
                .longDescription("a longer description of test note")
                .expirationTime("2120-10-02T15:01:23.045123456Z")
                .relatedUrls(            
                    NoteRelatedUrlArgs.builder()
                        .url("some.url")
                        .label("foo")
                        .build(),
                    NoteRelatedUrlArgs.builder()
                        .url("google.com")
                        .build())
                .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                    .hint(NoteAttestationAuthorityHintArgs.builder()
                        .humanReadableName("Attestor Note")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      note:
        type: gcp:containeranalysis:Note
        properties:
          name: attestor-note
          shortDescription: test note
          longDescription: a longer description of test note
          expirationTime: 2120-10-02T15:01:23.045123456Z
          relatedUrls:
            - url: some.url
              label: foo
            - url: google.com
          attestationAuthority:
            hint:
              humanReadableName: Attestor Note
    

    Create Note Resource

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

    Constructor syntax

    new Note(name: string, args: NoteArgs, opts?: CustomResourceOptions);
    @overload
    def Note(resource_name: str,
             args: NoteArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Note(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             attestation_authority: Optional[NoteAttestationAuthorityArgs] = None,
             expiration_time: Optional[str] = None,
             long_description: Optional[str] = None,
             name: Optional[str] = None,
             project: Optional[str] = None,
             related_note_names: Optional[Sequence[str]] = None,
             related_urls: Optional[Sequence[NoteRelatedUrlArgs]] = None,
             short_description: Optional[str] = None)
    func NewNote(ctx *Context, name string, args NoteArgs, opts ...ResourceOption) (*Note, error)
    public Note(string name, NoteArgs args, CustomResourceOptions? opts = null)
    public Note(String name, NoteArgs args)
    public Note(String name, NoteArgs args, CustomResourceOptions options)
    
    type: gcp:containeranalysis:Note
    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 NoteArgs
    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 NoteArgs
    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 NoteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NoteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NoteArgs
    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 noteResource = new Gcp.ContainerAnalysis.Note("noteResource", new()
    {
        AttestationAuthority = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityArgs
        {
            Hint = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityHintArgs
            {
                HumanReadableName = "string",
            },
        },
        ExpirationTime = "string",
        LongDescription = "string",
        Name = "string",
        Project = "string",
        RelatedNoteNames = new[]
        {
            "string",
        },
        RelatedUrls = new[]
        {
            new Gcp.ContainerAnalysis.Inputs.NoteRelatedUrlArgs
            {
                Url = "string",
                Label = "string",
            },
        },
        ShortDescription = "string",
    });
    
    example, err := containeranalysis.NewNote(ctx, "noteResource", &containeranalysis.NoteArgs{
    	AttestationAuthority: &containeranalysis.NoteAttestationAuthorityArgs{
    		Hint: &containeranalysis.NoteAttestationAuthorityHintArgs{
    			HumanReadableName: pulumi.String("string"),
    		},
    	},
    	ExpirationTime:  pulumi.String("string"),
    	LongDescription: pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Project:         pulumi.String("string"),
    	RelatedNoteNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RelatedUrls: containeranalysis.NoteRelatedUrlArray{
    		&containeranalysis.NoteRelatedUrlArgs{
    			Url:   pulumi.String("string"),
    			Label: pulumi.String("string"),
    		},
    	},
    	ShortDescription: pulumi.String("string"),
    })
    
    var noteResource = new Note("noteResource", NoteArgs.builder()
        .attestationAuthority(NoteAttestationAuthorityArgs.builder()
            .hint(NoteAttestationAuthorityHintArgs.builder()
                .humanReadableName("string")
                .build())
            .build())
        .expirationTime("string")
        .longDescription("string")
        .name("string")
        .project("string")
        .relatedNoteNames("string")
        .relatedUrls(NoteRelatedUrlArgs.builder()
            .url("string")
            .label("string")
            .build())
        .shortDescription("string")
        .build());
    
    note_resource = gcp.containeranalysis.Note("noteResource",
        attestation_authority=gcp.containeranalysis.NoteAttestationAuthorityArgs(
            hint=gcp.containeranalysis.NoteAttestationAuthorityHintArgs(
                human_readable_name="string",
            ),
        ),
        expiration_time="string",
        long_description="string",
        name="string",
        project="string",
        related_note_names=["string"],
        related_urls=[gcp.containeranalysis.NoteRelatedUrlArgs(
            url="string",
            label="string",
        )],
        short_description="string")
    
    const noteResource = new gcp.containeranalysis.Note("noteResource", {
        attestationAuthority: {
            hint: {
                humanReadableName: "string",
            },
        },
        expirationTime: "string",
        longDescription: "string",
        name: "string",
        project: "string",
        relatedNoteNames: ["string"],
        relatedUrls: [{
            url: "string",
            label: "string",
        }],
        shortDescription: "string",
    });
    
    type: gcp:containeranalysis:Note
    properties:
        attestationAuthority:
            hint:
                humanReadableName: string
        expirationTime: string
        longDescription: string
        name: string
        project: string
        relatedNoteNames:
            - string
        relatedUrls:
            - label: string
              url: string
        shortDescription: string
    

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

    AttestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    ExpirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    LongDescription string
    A detailed description of the note
    Name string
    The name of the note.
    Project string
    RelatedNoteNames List<string>
    Names of other notes related to this note.
    RelatedUrls List<NoteRelatedUrl>
    URLs associated with this note and related metadata.
    ShortDescription string
    A one sentence description of the note.
    AttestationAuthority NoteAttestationAuthorityArgs
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    ExpirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    LongDescription string
    A detailed description of the note
    Name string
    The name of the note.
    Project string
    RelatedNoteNames []string
    Names of other notes related to this note.
    RelatedUrls []NoteRelatedUrlArgs
    URLs associated with this note and related metadata.
    ShortDescription string
    A one sentence description of the note.
    attestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    expirationTime String
    Time of expiration for this note. Leave empty if note does not expire.
    longDescription String
    A detailed description of the note
    name String
    The name of the note.
    project String
    relatedNoteNames List<String>
    Names of other notes related to this note.
    relatedUrls List<NoteRelatedUrl>
    URLs associated with this note and related metadata.
    shortDescription String
    A one sentence description of the note.
    attestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    expirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    longDescription string
    A detailed description of the note
    name string
    The name of the note.
    project string
    relatedNoteNames string[]
    Names of other notes related to this note.
    relatedUrls NoteRelatedUrl[]
    URLs associated with this note and related metadata.
    shortDescription string
    A one sentence description of the note.
    attestation_authority NoteAttestationAuthorityArgs
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    expiration_time str
    Time of expiration for this note. Leave empty if note does not expire.
    long_description str
    A detailed description of the note
    name str
    The name of the note.
    project str
    related_note_names Sequence[str]
    Names of other notes related to this note.
    related_urls Sequence[NoteRelatedUrlArgs]
    URLs associated with this note and related metadata.
    short_description str
    A one sentence description of the note.
    attestationAuthority Property Map
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    expirationTime String
    Time of expiration for this note. Leave empty if note does not expire.
    longDescription String
    A detailed description of the note
    name String
    The name of the note.
    project String
    relatedNoteNames List<String>
    Names of other notes related to this note.
    relatedUrls List<Property Map>
    URLs associated with this note and related metadata.
    shortDescription String
    A one sentence description of the note.

    Outputs

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

    CreateTime string
    The time this note was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The type of analysis this note describes
    UpdateTime string
    The time this note was last updated.
    CreateTime string
    The time this note was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The type of analysis this note describes
    UpdateTime string
    The time this note was last updated.
    createTime String
    The time this note was created.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The type of analysis this note describes
    updateTime String
    The time this note was last updated.
    createTime string
    The time this note was created.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The type of analysis this note describes
    updateTime string
    The time this note was last updated.
    create_time str
    The time this note was created.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    The type of analysis this note describes
    update_time str
    The time this note was last updated.
    createTime String
    The time this note was created.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The type of analysis this note describes
    updateTime String
    The time this note was last updated.

    Look up Existing Note Resource

    Get an existing Note 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>, state?: NoteState, opts?: CustomResourceOptions): Note
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attestation_authority: Optional[NoteAttestationAuthorityArgs] = None,
            create_time: Optional[str] = None,
            expiration_time: Optional[str] = None,
            kind: Optional[str] = None,
            long_description: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            related_note_names: Optional[Sequence[str]] = None,
            related_urls: Optional[Sequence[NoteRelatedUrlArgs]] = None,
            short_description: Optional[str] = None,
            update_time: Optional[str] = None) -> Note
    func GetNote(ctx *Context, name string, id IDInput, state *NoteState, opts ...ResourceOption) (*Note, error)
    public static Note Get(string name, Input<string> id, NoteState? state, CustomResourceOptions? opts = null)
    public static Note get(String name, Output<String> id, NoteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AttestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    CreateTime string
    The time this note was created.
    ExpirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    Kind string
    The type of analysis this note describes
    LongDescription string
    A detailed description of the note
    Name string
    The name of the note.
    Project string
    RelatedNoteNames List<string>
    Names of other notes related to this note.
    RelatedUrls List<NoteRelatedUrl>
    URLs associated with this note and related metadata.
    ShortDescription string
    A one sentence description of the note.
    UpdateTime string
    The time this note was last updated.
    AttestationAuthority NoteAttestationAuthorityArgs
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    CreateTime string
    The time this note was created.
    ExpirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    Kind string
    The type of analysis this note describes
    LongDescription string
    A detailed description of the note
    Name string
    The name of the note.
    Project string
    RelatedNoteNames []string
    Names of other notes related to this note.
    RelatedUrls []NoteRelatedUrlArgs
    URLs associated with this note and related metadata.
    ShortDescription string
    A one sentence description of the note.
    UpdateTime string
    The time this note was last updated.
    attestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    createTime String
    The time this note was created.
    expirationTime String
    Time of expiration for this note. Leave empty if note does not expire.
    kind String
    The type of analysis this note describes
    longDescription String
    A detailed description of the note
    name String
    The name of the note.
    project String
    relatedNoteNames List<String>
    Names of other notes related to this note.
    relatedUrls List<NoteRelatedUrl>
    URLs associated with this note and related metadata.
    shortDescription String
    A one sentence description of the note.
    updateTime String
    The time this note was last updated.
    attestationAuthority NoteAttestationAuthority
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    createTime string
    The time this note was created.
    expirationTime string
    Time of expiration for this note. Leave empty if note does not expire.
    kind string
    The type of analysis this note describes
    longDescription string
    A detailed description of the note
    name string
    The name of the note.
    project string
    relatedNoteNames string[]
    Names of other notes related to this note.
    relatedUrls NoteRelatedUrl[]
    URLs associated with this note and related metadata.
    shortDescription string
    A one sentence description of the note.
    updateTime string
    The time this note was last updated.
    attestation_authority NoteAttestationAuthorityArgs
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    create_time str
    The time this note was created.
    expiration_time str
    Time of expiration for this note. Leave empty if note does not expire.
    kind str
    The type of analysis this note describes
    long_description str
    A detailed description of the note
    name str
    The name of the note.
    project str
    related_note_names Sequence[str]
    Names of other notes related to this note.
    related_urls Sequence[NoteRelatedUrlArgs]
    URLs associated with this note and related metadata.
    short_description str
    A one sentence description of the note.
    update_time str
    The time this note was last updated.
    attestationAuthority Property Map
    Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. Structure is documented below.
    createTime String
    The time this note was created.
    expirationTime String
    Time of expiration for this note. Leave empty if note does not expire.
    kind String
    The type of analysis this note describes
    longDescription String
    A detailed description of the note
    name String
    The name of the note.
    project String
    relatedNoteNames List<String>
    Names of other notes related to this note.
    relatedUrls List<Property Map>
    URLs associated with this note and related metadata.
    shortDescription String
    A one sentence description of the note.
    updateTime String
    The time this note was last updated.

    Supporting Types

    NoteAttestationAuthority, NoteAttestationAuthorityArgs

    Hint NoteAttestationAuthorityHint
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.
    Hint NoteAttestationAuthorityHint
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.
    hint NoteAttestationAuthorityHint
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.
    hint NoteAttestationAuthorityHint
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.
    hint NoteAttestationAuthorityHint
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.
    hint Property Map
    This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Structure is documented below.

    NoteAttestationAuthorityHint, NoteAttestationAuthorityHintArgs

    HumanReadableName string
    The human readable name of this Attestation Authority, for example "qa".


    HumanReadableName string
    The human readable name of this Attestation Authority, for example "qa".


    humanReadableName String
    The human readable name of this Attestation Authority, for example "qa".


    humanReadableName string
    The human readable name of this Attestation Authority, for example "qa".


    human_readable_name str
    The human readable name of this Attestation Authority, for example "qa".


    humanReadableName String
    The human readable name of this Attestation Authority, for example "qa".


    NoteRelatedUrl, NoteRelatedUrlArgs

    Url string
    Specific URL associated with the resource.
    Label string
    Label to describe usage of the URL
    Url string
    Specific URL associated with the resource.
    Label string
    Label to describe usage of the URL
    url String
    Specific URL associated with the resource.
    label String
    Label to describe usage of the URL
    url string
    Specific URL associated with the resource.
    label string
    Label to describe usage of the URL
    url str
    Specific URL associated with the resource.
    label str
    Label to describe usage of the URL
    url String
    Specific URL associated with the resource.
    label String
    Label to describe usage of the URL

    Import

    Note can be imported using any of these accepted formats:

    • projects/{{project}}/notes/{{name}}

    • {{project}}/{{name}}

    • {{name}}

    When using the pulumi import command, Note can be imported using one of the formats above. For example:

    $ pulumi import gcp:containeranalysis/note:Note default projects/{{project}}/notes/{{name}}
    
    $ pulumi import gcp:containeranalysis/note:Note default {{project}}/{{name}}
    
    $ pulumi import gcp:containeranalysis/note:Note default {{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi