SnapshotInfo interface

Fields that uniquely identify a snapshot

Properties

compositionType

The composition type describes how the key-values within the snapshot are composed. The 'all' composition type includes all key-values. The 'group_by_key' composition type ensures there are no two key-values containing the same key.

filters

A list of filters used to filter the key-values included in the snapshot.

name

The name for this snapshot

retentionPeriodInSeconds

The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.

tags

The tags of the snapshot.

Property Details

compositionType

The composition type describes how the key-values within the snapshot are composed. The 'all' composition type includes all key-values. The 'group_by_key' composition type ensures there are no two key-values containing the same key.

compositionType?: string

Property Value

string

filters

A list of filters used to filter the key-values included in the snapshot.

filters: ConfigurationSettingsFilter[]

Property Value

name

The name for this snapshot

name: string

Property Value

string

retentionPeriodInSeconds

The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.

retentionPeriodInSeconds?: number

Property Value

number

tags

The tags of the snapshot.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}