1. Docs
  2. Reference
  3. API
  4. GCP
  5. containeranalysis
  6. Note

Note

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:

Create a Note Resource

new Note(name: string, args: NoteArgs, opts?: CustomResourceOptions);
def Note(resource_name, opts=None, attestation_authority=None, expiration_time=None, long_description=None, name=None, project=None, related_note_names=None, related_urls=None, short_description=None, __props__=None);
func NewNote(ctx *Context, name string, args NoteArgs, opts ...ResourceOption) (*Note, error)
public Note(string name, NoteArgs args, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Note Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Note resource accepts the following input properties:

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

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

RelatedNoteNames List<string>

Names of other notes related to this note.

RelatedUrls List<NoteRelatedUrlArgs>

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

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

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

RelatedNoteNames []string

Names of other notes related to this note.

RelatedUrls []NoteRelatedUrl

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

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

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

relatedNoteNames string[]

Names of other notes related to this note.

relatedUrls NoteRelatedUrl[]

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

shortDescription string

A one sentence description of the note.

attestation_authority Dict[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.

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

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

related_note_names List[str]

Names of other notes related to this note.

related_urls List[NoteRelatedUrl]

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

short_description str

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.

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.

Look up an 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
static get(resource_name, id, opts=None, attestation_authority=None, create_time=None, expiration_time=None, kind=None, long_description=None, name=None, project=None, related_note_names=None, related_urls=None, short_description=None, update_time=None, __props__=None);
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)
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.

The following state arguments are supported:

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

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

RelatedNoteNames List<string>

Names of other notes related to this note.

RelatedUrls List<NoteRelatedUrlArgs>

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

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

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

RelatedNoteNames []string

Names of other notes related to this note.

RelatedUrls []NoteRelatedUrl

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

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

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

relatedNoteNames string[]

Names of other notes related to this note.

relatedUrls NoteRelatedUrl[]

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

shortDescription string

A one sentence description of the note.

updateTime string

The time this note was last updated.

attestation_authority Dict[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.

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

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

related_note_names List[str]

Names of other notes related to this note.

related_urls List[NoteRelatedUrl]

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

short_description str

A one sentence description of the note.

update_time str

The time this note was last updated.

Supporting Types

NoteAttestationAuthority

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Hint NoteAttestationAuthorityHintArgs

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 Dict[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.

NoteAttestationAuthorityHint

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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 str

The human readable name of this Attestation Authority, for example “qa”.

NoteRelatedUrl

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.