pulumi-gcp-kotlin/com.pulumi.gcp.containeranalysis.kotlin/NoteArgs

NoteArgs

data class NoteArgs(val attestationAuthority: Output<NoteAttestationAuthorityArgs>? = null, val expirationTime: Output<String>? = null, val longDescription: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val relatedNoteNames: Output<List<String>>? = null, val relatedUrls: Output<List<NoteRelatedUrlArgs>>? = null, val shortDescription: Output<String>? = null) : ConvertibleToJava<NoteArgs>

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

Example Usage

Container Analysis Note Basic

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()
            .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                .hint(NoteAttestationAuthorityHintArgs.builder()
                    .humanReadableName("Attestor Note")
                    .build())
                .build())
            .build());
    }
}

Container Analysis Note Attestation Full

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 com.pulumi.gcp.containeranalysis.inputs.NoteRelatedUrlArgs;
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()
            .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                .hint(NoteAttestationAuthorityHintArgs.builder()
                    .humanReadableName("Attestor Note")
                    .build())
                .build())
            .expirationTime("2120-10-02T15:01:23.045123456Z")
            .longDescription("a longer description of test note")
            .relatedUrls(
                NoteRelatedUrlArgs.builder()
                    .label("foo")
                    .url("some.url")
                    .build(),
                NoteRelatedUrlArgs.builder()
                    .url("google.com")
                    .build())
            .shortDescription("test note")
            .build());
    }
}

Import

Note can be imported using any of these accepted formats

$ 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

NoteArgs

constructor(attestationAuthority: Output<NoteAttestationAuthorityArgs>? = null, expirationTime: Output<String>? = null, longDescription: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, relatedNoteNames: Output<List<String>>? = null, relatedUrls: Output<List<NoteRelatedUrlArgs>>? = null, shortDescription: Output<String>? = null)

Properties

attestationAuthority

val attestationAuthority: Output<NoteAttestationAuthorityArgs>? = null

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

val expirationTime: Output<String>? = null

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

longDescription

val longDescription: Output<String>? = null

A detailed description of the note

name

val name: Output<String>? = null

The name of the note.

project

val project: Output<String>? = null

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