Package version:

Interface SnapshotInfo

Fields that uniquely identify a snapshot

interface SnapshotInfo {
    compositionType?: string;
    filters: ConfigurationSettingsFilter[];
    name: string;
    retentionPeriodInSeconds?: number;
    tags?: {
        [propertyName: string]: string;
    };
}

Properties

compositionType? filters name retentionPeriodInSeconds? tags?

Properties

OptionalcompositionType

compositionType?: string

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

filters: ConfigurationSettingsFilter[]

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

name

name: string

The name for this snapshot

OptionalretentionPeriodInSeconds

retentionPeriodInSeconds?: number

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.

Optionaltags

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

The tags of the snapshot.

Settings

Member Visibility