AppConfig
public struct AppConfig
Client object for interacting with AWS AppConfig service.
AWS AppConfig Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices. To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version. AppConfig supports multiple use cases. Here are some examples. Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic. Feature toggle: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement. Allow list: Use AppConfig to allow premium subscribers to access paid content. Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system. This reference is intended to be used with the AWS AppConfig User Guide.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AppConfig client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
Declaration
Swift
public func createApplication(_ input: CreateApplicationRequest) -> EventLoopFuture<Application>
-
Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information. The Uri location of the configuration data. The AWS Identity and Access Management (IAM) role that provides access to the configuration data. A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function. For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.
Declaration
Swift
public func createConfigurationProfile(_ input: CreateConfigurationProfileRequest) -> EventLoopFuture<ConfigurationProfile>
-
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.
Declaration
Swift
public func createDeploymentStrategy(_ input: CreateDeploymentStrategyRequest) -> EventLoopFuture<DeploymentStrategy>
-
For each application, you define one or more environments. An environment is a logical 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.
Declaration
Swift
public func createEnvironment(_ input: CreateEnvironmentRequest) -> EventLoopFuture<Environment>
-
Create a new configuration in the AppConfig configuration store.
Declaration
Swift
public func createHostedConfigurationVersion(_ input: CreateHostedConfigurationVersionRequest) -> EventLoopFuture<HostedConfigurationVersion>
-
Delete an application. Deleting an application does not delete a configuration from a host.
Declaration
Swift
@discardableResult public func deleteApplication(_ input: DeleteApplicationRequest) -> EventLoopFuture<Void>
-
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
Declaration
Swift
@discardableResult public func deleteConfigurationProfile(_ input: DeleteConfigurationProfileRequest) -> EventLoopFuture<Void>
-
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
Declaration
Swift
@discardableResult public func deleteDeploymentStrategy(_ input: DeleteDeploymentStrategyRequest) -> EventLoopFuture<Void>
-
Delete an environment. Deleting an environment does not delete a configuration from a host.
Declaration
Swift
@discardableResult public func deleteEnvironment(_ input: DeleteEnvironmentRequest) -> EventLoopFuture<Void>
-
Delete a version of a configuration from the AppConfig configuration store.
Declaration
Swift
@discardableResult public func deleteHostedConfigurationVersion(_ input: DeleteHostedConfigurationVersionRequest) -> EventLoopFuture<Void>
-
Retrieve information about an application.
Declaration
Swift
public func getApplication(_ input: GetApplicationRequest) -> EventLoopFuture<Application>
-
Receive information about a configuration. AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration. To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.
Declaration
Swift
public func getConfiguration(_ input: GetConfigurationRequest) -> EventLoopFuture<Configuration>
-
Retrieve information about a configuration profile.
Declaration
Swift
public func getConfigurationProfile(_ input: GetConfigurationProfileRequest) -> EventLoopFuture<ConfigurationProfile>
-
Retrieve information about a configuration deployment.
Declaration
Swift
public func getDeployment(_ input: GetDeploymentRequest) -> EventLoopFuture<Deployment>
-
Retrieve 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.
Declaration
Swift
public func getDeploymentStrategy(_ input: GetDeploymentStrategyRequest) -> EventLoopFuture<DeploymentStrategy>
-
Retrieve information about an environment. An environment is a logical 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.
Declaration
Swift
public func getEnvironment(_ input: GetEnvironmentRequest) -> EventLoopFuture<Environment>
-
Get information about a specific configuration version.
Declaration
Swift
public func getHostedConfigurationVersion(_ input: GetHostedConfigurationVersionRequest) -> EventLoopFuture<HostedConfigurationVersion>
-
List all applications in your AWS account.
Declaration
Swift
public func listApplications(_ input: ListApplicationsRequest) -> EventLoopFuture<Applications>
-
Lists the configuration profiles for an application.
Declaration
Swift
public func listConfigurationProfiles(_ input: ListConfigurationProfilesRequest) -> EventLoopFuture<ConfigurationProfiles>
-
List deployment strategies.
Declaration
Swift
public func listDeploymentStrategies(_ input: ListDeploymentStrategiesRequest) -> EventLoopFuture<DeploymentStrategies>
-
Lists the deployments for an environment.
Declaration
Swift
public func listDeployments(_ input: ListDeploymentsRequest) -> EventLoopFuture<Deployments>
-
List the environments for an application.
Declaration
Swift
public func listEnvironments(_ input: ListEnvironmentsRequest) -> EventLoopFuture<Environments>
-
View a list of configurations stored in the AppConfig configuration store by version.
Declaration
Swift
public func listHostedConfigurationVersions(_ input: ListHostedConfigurationVersionsRequest) -> EventLoopFuture<HostedConfigurationVersions>
-
Retrieves the list of key-value tags assigned to the resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ResourceTags>
-
Starts a deployment.
Declaration
Swift
public func startDeployment(_ input: StartDeploymentRequest) -> EventLoopFuture<Deployment>
-
Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.
Declaration
Swift
public func stopDeployment(_ input: StopDeploymentRequest) -> EventLoopFuture<Deployment>
-
Metadata to assign 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.
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>
-
Deletes a tag key and value from an AppConfig resource.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>
-
Updates an application.
Declaration
Swift
public func updateApplication(_ input: UpdateApplicationRequest) -> EventLoopFuture<Application>
-
Updates a configuration profile.
Declaration
Swift
public func updateConfigurationProfile(_ input: UpdateConfigurationProfileRequest) -> EventLoopFuture<ConfigurationProfile>
-
Updates a deployment strategy.
Declaration
Swift
public func updateDeploymentStrategy(_ input: UpdateDeploymentStrategyRequest) -> EventLoopFuture<DeploymentStrategy>
-
Updates an environment.
Declaration
Swift
public func updateEnvironment(_ input: UpdateEnvironmentRequest) -> EventLoopFuture<Environment>
-
Uses the validators in a configuration profile to validate a configuration.
Declaration
Swift
@discardableResult public func validateConfiguration(_ input: ValidateConfigurationRequest) -> EventLoopFuture<Void>
-
List all applications in your AWS account.
Declaration
Swift
public func listApplicationsPaginator(_ input: ListApplicationsRequest, onPage: @escaping (Applications, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the configuration profiles for an application.
Declaration
Swift
public func listConfigurationProfilesPaginator(_ input: ListConfigurationProfilesRequest, onPage: @escaping (ConfigurationProfiles, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
List deployment strategies.
Declaration
Swift
public func listDeploymentStrategiesPaginator(_ input: ListDeploymentStrategiesRequest, onPage: @escaping (DeploymentStrategies, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the deployments for an environment.
Declaration
Swift
public func listDeploymentsPaginator(_ input: ListDeploymentsRequest, onPage: @escaping (Deployments, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
List the environments for an application.
Declaration
Swift
public func listEnvironmentsPaginator(_ input: ListEnvironmentsRequest, onPage: @escaping (Environments, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
View a list of configurations stored in the AppConfig configuration store by version.
Declaration
Swift
public func listHostedConfigurationVersionsPaginator(_ input: ListHostedConfigurationVersionsRequest, onPage: @escaping (HostedConfigurationVersions, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListApplicationsRequest : AWSShape
extension AppConfig.ListApplicationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListConfigurationProfilesRequest : AWSShape
extension AppConfig.ListConfigurationProfilesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDeploymentStrategiesRequest : AWSShape
extension AppConfig.ListDeploymentStrategiesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDeploymentsRequest : AWSShape
extension AppConfig.ListDeploymentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListEnvironmentsRequest : AWSShape
extension AppConfig.ListEnvironmentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListHostedConfigurationVersionsRequest : AWSShape
extension AppConfig.ListHostedConfigurationVersionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum DeploymentEventType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DeploymentState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum EnvironmentState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum GrowthType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReplicateTo : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum TriggeredBy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ValidatorType : String, CustomStringConvertible, Codable