Package-level declarations

Types

Link copied to clipboard

AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

Link copied to clipboard

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:

Link copied to clipboard

Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Link copied to clipboard

Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

Link copied to clipboard

Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.

Link copied to clipboard

When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.

Link copied to clipboard

Deletes an application.

Link copied to clipboard

Deletes a configuration profile.

Link copied to clipboard

Deletes a deployment strategy.

Link copied to clipboard

Deletes an environment.

Link copied to clipboard

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Link copied to clipboard

Deletes an extension association. This action doesn't delete extensions defined in the association.

Link copied to clipboard

Deletes a version of a configuration from the AppConfig hosted configuration store.

Link copied to clipboard

Returns information about the status of the DeletionProtection parameter.

Link copied to clipboard

Retrieves information about an application.

Link copied to clipboard

(Deprecated) Retrieves the latest deployed configuration.

Link copied to clipboard

Retrieves information about a configuration profile.

Link copied to clipboard

Retrieves information about a configuration deployment.

Link copied to clipboard

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Link copied to clipboard

Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

Link copied to clipboard

Returns information about an AppConfig extension.

Link copied to clipboard

Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Retrieves information about a specific configuration version.

Link copied to clipboard

Lists all applications in your Amazon Web Services account.

Link copied to clipboard

Lists the configuration profiles for an application.

Link copied to clipboard

Lists the deployments for an environment in descending deployment number order.

Link copied to clipboard

Lists deployment strategies.

Link copied to clipboard

Lists the environments for an application.

Link copied to clipboard

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Lists configurations stored in the AppConfig hosted configuration store by version.

Link copied to clipboard

Retrieves the list of key-value tags assigned to the resource.

Link copied to clipboard

Starts a deployment.

Link copied to clipboard

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.

Link copied to clipboard
inline suspend fun AppConfigClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

Link copied to clipboard

Deletes a tag key and value from an AppConfig resource.

Link copied to clipboard

Updates the value of the DeletionProtection parameter.

Link copied to clipboard

Updates an application.

Link copied to clipboard

Updates a configuration profile.

Link copied to clipboard

Updates a deployment strategy.

Link copied to clipboard

Updates an environment.

Link copied to clipboard

Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Link copied to clipboard

Uses the validators in a configuration profile to validate a configuration.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.