Note class

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:

• API documentation
• How-to Guides
• Creating Attestations (Occurrences)
• Official Documentation

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={
        "hint": {
            "human_readable_name": "Attestor Note",
        },
    })

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_containeranalysis_note" "note" {
  name = "attestor-note"
  attestation_authority = {
    hint = {
      human_readable_name = "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.ArrayList;
import java.util.Arrays;
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=[
        {
            "url": "some.url",
            "label": "foo",
        },
        {
            "url": "google.com",
        },
    ],
    attestation_authority={
        "hint": {
            "human_readable_name": "Attestor Note",
        },
    })

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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 {
    url   = "some.url"
    label = "foo"
  }
  related_urls {
    url = "google.com"
  }
  attestation_authority = {
    hint = {
      human_readable_name = "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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

Note(String name, {NoteArgs? args, CustomResourceOptions? options})

Creates a new Note. name The Pulumi resource name. args Arguments used to configure this Note. The set of arguments for Note. options Resource options controlling this resource's behavior.

Note.reference(String urn)

Creates a typed reference to an existing Note resource.

Properties

attestationAuthority ↔ Output<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.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time this note was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

expirationTime ↔ Output<String?>

Time of expiration for this note. Leave empty if note does not expire.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

The type of analysis this note describes

late, final

longDescription ↔ Output<String?>

A detailed description of the note

late, final

name ↔ Output<String>

The name of the note.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

relatedNoteNames ↔ Output<List<String>?>

Names of other notes related to this note.

late, final

relatedUrls ↔ Output<List<NoteRelatedUrl>?>

URLs associated with this note and related metadata. Structure is documented below.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shortDescription ↔ Output<String?>

A one sentence description of the note.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The time this note was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {NoteState? state, CustomResourceOptions? options}) → Note

Gets an existing Note resource's state with the given name and id.