update_configuration_bundle¶
Operation¶
async
¶
update_configuration_bundle(input: UpdateConfigurationBundleInput, plugins: list[Plugin] | None = None) -> UpdateConfigurationBundleOutput
Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateConfigurationBundleInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateConfigurationBundleOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateConfigurationBundleInput structure.
Attributes¶
class-attribute
instance-attribute
¶
branch_name: str | None = None
The branch name for this version. If not specified, inherits the
parent's branch or defaults to mainline.
class-attribute
instance-attribute
¶
bundle_id: str | None = None
The unique identifier of the configuration bundle to update.
class-attribute
instance-attribute
¶
bundle_name: str | None = None
The updated name for the configuration bundle.
class-attribute
instance-attribute
¶
client_token: str | None = None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
class-attribute
instance-attribute
¶
commit_message: str | None = None
A commit message describing the changes in this version.
class-attribute
instance-attribute
¶
components: dict[str, ComponentConfiguration] | None = None
The updated component configurations. Creates a new version of the bundle.
class-attribute
instance-attribute
¶
created_by: VersionCreatedBySource | None = None
The source that created this version, including the source name and optional ARN.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The updated description for the configuration bundle.
class-attribute
instance-attribute
¶
kms_key_arn: str | None = None
Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.
class-attribute
instance-attribute
¶
parent_version_ids: list[str] | None = None
A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.
Output¶
dataclass
¶
Dataclass for UpdateConfigurationBundleOutput structure.
Attributes¶
instance-attribute
¶
bundle_arn: str
The Amazon Resource Name (ARN) of the updated configuration bundle.
instance-attribute
¶
bundle_id: str
The unique identifier of the updated configuration bundle.
instance-attribute
¶
updated_at: datetime
The timestamp when the configuration bundle was updated.