ConfigurationSnapshot Class

Reference

A point-in-time snapshot of configuration settings.

Inheritance: builtins.object

ConfigurationSnapshot

Constructor

ConfigurationSnapshot(filters: List[ConfigurationSettingsFilter], *, composition_type: str | SnapshotComposition | None = None, retention_period: int | None = None, tags: Dict[str, str] | None = None)

Parameters

Name	Description
filters Required	list[ConfigurationSettingsFilter] A list of filters used to filter the key-values included in the configuration snapshot. Required.

Keyword-Only Parameters

Name	Description
composition_type	str or None The composition type describes how the key-values within the configuration snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. Known values are: "key" and "key_label".
retention_period	int or None The amount of time, in seconds, that a configuration snapshot will remain in the archived state before expiring. This property is only writable during the creation of a configuration snapshot. If not specified, the default lifetime of key-value revisions will be used.
tags	dict[str, str] or None The tags of the configuration snapshot.

Attributes

composition_type

The composition type describes how the key-values within the configuration snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. Known values are: "key" and "key_label".

composition_type: str | SnapshotComposition | None

created

The time that the configuration snapshot was created.

created: datetime | None

etag

A value representing the current state of the configuration snapshot.

etag: str | None

expires

The time that the configuration snapshot will expire.

expires: datetime | None

filters

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

filters: List[ConfigurationSettingsFilter]

items_count

The amount of key-values in the configuration snapshot.

items_count: int | None

name

The name of the configuration snapshot.

name: str | None

retention_period

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

retention_period: int | None

size

The size in bytes of the configuration snapshot.

size: int | None

status

"provisioning", "ready", "archived", and "failed".

status: str | SnapshotStatus | None

Share via