class AmazonAppConfig::Methods::AmazonAppConfigMethods
- AmazonAppConfig::Methods::AmazonAppConfigMethods
- Reference
- Object
Defined in:
clients/appconfig.crConstructors
Instance Method Summary
-
#create_application(name : String, description : String | Nil = nil, tags : Hash(String, String) | Nil = nil) : ApplicationStruct
An application in AppConfig is a logical unit of code that provides capabilities for your customers.
- #create_application(input : CreateApplicationRequest) : ApplicationStruct
-
#create_configuration_profile(application_id : String, name : String, location_uri : String, description : String | Nil = nil, retrieval_role_arn : String | Nil = nil, validators : Array(ValidatorStruct) | Nil = nil, tags : Hash(String, String) | Nil = nil) : ConfigurationProfileStruct
Information that enables AppConfig to access the configuration source.
- #create_configuration_profile(input : CreateConfigurationProfileRequest) : ConfigurationProfileStruct
-
#create_deployment_strategy(name : String, deployment_duration_in_minutes : Int32, growth_factor : Float32, replicate_to : String, description : String | Nil = nil, final_bake_time_in_minutes : Int32 | Nil = nil, growth_type : String | Nil = nil, tags : Hash(String, String) | Nil = nil) : DeploymentStrategyStruct
A deployment strategy defines important criteria for rolling out your configuration to the designated targets.
- #create_deployment_strategy(input : CreateDeploymentStrategyRequest) : DeploymentStrategyStruct
-
#create_environment(application_id : String, name : String, description : String | Nil = nil, monitors : Array(MonitorStruct) | Nil = nil, tags : Hash(String, String) | Nil = nil) : EnvironmentStruct
For each application, you define one or more environments.
- #create_environment(input : CreateEnvironmentRequest) : EnvironmentStruct
-
#create_hosted_configuration_version(application_id : String, configuration_profile_id : String, content : IO | String | Bytes, content_type : String, description : String | Nil = nil, latest_version_number : Int32 | Nil = nil) : HostedConfigurationVersionStruct
Create a new configuration in the AppConfig configuration store.
- #create_hosted_configuration_version(input : CreateHostedConfigurationVersionRequest) : HostedConfigurationVersionStruct
-
#delete_application(application_id : String) : Nil
Delete an application.
- #delete_application(input : DeleteApplicationRequest) : Nil
-
#delete_configuration_profile(application_id : String, configuration_profile_id : String) : Nil
Delete a configuration profile.
- #delete_configuration_profile(input : DeleteConfigurationProfileRequest) : Nil
-
#delete_deployment_strategy(deployment_strategy_id : String) : Nil
Delete a deployment strategy.
- #delete_deployment_strategy(input : DeleteDeploymentStrategyRequest) : Nil
-
#delete_environment(application_id : String, environment_id : String) : Nil
Delete an environment.
- #delete_environment(input : DeleteEnvironmentRequest) : Nil
-
#delete_hosted_configuration_version(application_id : String, configuration_profile_id : String, version_number : Int32) : Nil
Delete a version of a configuration from the AppConfig configuration store.
- #delete_hosted_configuration_version(input : DeleteHostedConfigurationVersionRequest) : Nil
-
#get_application(application_id : String) : ApplicationStruct
Retrieve information about an application.
- #get_application(input : GetApplicationRequest) : ApplicationStruct
-
#get_configuration(application : String, environment : String, configuration : String, client_id : String, client_configuration_version : String | Nil = nil) : ConfigurationStruct
Receive information about a configuration.
AWS AppConfig uses the value of the
ClientConfigurationVersionparameter to identify the configuration version on your clients. - #get_configuration(input : GetConfigurationRequest) : ConfigurationStruct
-
#get_configuration_profile(application_id : String, configuration_profile_id : String) : ConfigurationProfileStruct
Retrieve information about a configuration profile.
- #get_configuration_profile(input : GetConfigurationProfileRequest) : ConfigurationProfileStruct
-
#get_deployment(application_id : String, environment_id : String, deployment_number : Int32) : DeploymentStruct
Retrieve information about a configuration deployment.
- #get_deployment(input : GetDeploymentRequest) : DeploymentStruct
-
#get_deployment_strategy(deployment_strategy_id : String) : DeploymentStrategyStruct
Retrieve information about a deployment strategy.
- #get_deployment_strategy(input : GetDeploymentStrategyRequest) : DeploymentStrategyStruct
-
#get_environment(application_id : String, environment_id : String) : EnvironmentStruct
Retrieve information about an environment.
- #get_environment(input : GetEnvironmentRequest) : EnvironmentStruct
-
#get_hosted_configuration_version(application_id : String, configuration_profile_id : String, version_number : Int32) : HostedConfigurationVersionStruct
Get information about a specific configuration version.
- #get_hosted_configuration_version(input : GetHostedConfigurationVersionRequest) : HostedConfigurationVersionStruct
-
#list_applications(max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : ApplicationsStruct
List all applications in your AWS account.
- #list_applications(input : ListApplicationsRequest) : ApplicationsStruct
-
#list_configuration_profiles(application_id : String, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : ConfigurationProfilesStruct
Lists the configuration profiles for an application.
- #list_configuration_profiles(input : ListConfigurationProfilesRequest) : ConfigurationProfilesStruct
-
#list_deployment_strategies(max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : DeploymentStrategiesStruct
List deployment strategies.
- #list_deployment_strategies(input : ListDeploymentStrategiesRequest) : DeploymentStrategiesStruct
-
#list_deployments(application_id : String, environment_id : String, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : DeploymentsStruct
Lists the deployments for an environment.
- #list_deployments(input : ListDeploymentsRequest) : DeploymentsStruct
-
#list_environments(application_id : String, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : EnvironmentsStruct
List the environments for an application.
- #list_environments(input : ListEnvironmentsRequest) : EnvironmentsStruct
-
#list_hosted_configuration_versions(application_id : String, configuration_profile_id : String, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) : HostedConfigurationVersionsStruct
View a list of configurations stored in the AppConfig configuration store by version.
- #list_hosted_configuration_versions(input : ListHostedConfigurationVersionsRequest) : HostedConfigurationVersionsStruct
-
#list_tags_for_resource(resource_arn : String) : ResourceTagsStruct
Retrieves the list of key-value tags assigned to the resource.
- #list_tags_for_resource(input : ListTagsForResourceRequest) : ResourceTagsStruct
- #send(request : HTTP::Request, prefix : String, success_code : Int32 | Nil)
-
#start_deployment(application_id : String, environment_id : String, deployment_strategy_id : String, configuration_profile_id : String, configuration_version : String, description : String | Nil = nil, tags : Hash(String, String) | Nil = nil) : DeploymentStruct
Starts a deployment.
- #start_deployment(input : StartDeploymentRequest) : DeploymentStruct
-
#stop_deployment(application_id : String, environment_id : String, deployment_number : Int32) : DeploymentStruct
Stops a deployment.
- #stop_deployment(input : StopDeploymentRequest) : DeploymentStruct
-
#tag_resource(resource_arn : String, tags : Hash(String, String)) : Nil
Metadata to assign to an AppConfig resource.
- #tag_resource(input : TagResourceRequest) : Nil
-
#untag_resource(resource_arn : String, tag_keys : Array(String)) : Nil
Deletes a tag key and value from an AppConfig resource.
- #untag_resource(input : UntagResourceRequest) : Nil
-
#update_application(application_id : String, name : String | Nil = nil, description : String | Nil = nil) : ApplicationStruct
Updates an application.
- #update_application(input : UpdateApplicationRequest) : ApplicationStruct
-
#update_configuration_profile(application_id : String, configuration_profile_id : String, name : String | Nil = nil, description : String | Nil = nil, retrieval_role_arn : String | Nil = nil, validators : Array(ValidatorStruct) | Nil = nil) : ConfigurationProfileStruct
Updates a configuration profile.
- #update_configuration_profile(input : UpdateConfigurationProfileRequest) : ConfigurationProfileStruct
-
#update_deployment_strategy(deployment_strategy_id : String, description : String | Nil = nil, deployment_duration_in_minutes : Int32 | Nil = nil, final_bake_time_in_minutes : Int32 | Nil = nil, growth_factor : Float32 | Nil = nil, growth_type : String | Nil = nil) : DeploymentStrategyStruct
Updates a deployment strategy.
- #update_deployment_strategy(input : UpdateDeploymentStrategyRequest) : DeploymentStrategyStruct
-
#update_environment(application_id : String, environment_id : String, name : String | Nil = nil, description : String | Nil = nil, monitors : Array(MonitorStruct) | Nil = nil) : EnvironmentStruct
Updates an environment.
- #update_environment(input : UpdateEnvironmentRequest) : EnvironmentStruct
-
#validate_configuration(application_id : String, configuration_profile_id : String, configuration_version : String) : Nil
Uses the validators in a configuration profile to validate a configuration.
- #validate_configuration(input : ValidateConfigurationRequest) : Nil
Constructor Detail
Instance Method Detail
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.
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.
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.
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.
Create a new configuration in the AppConfig configuration store.
Delete an application. Deleting an application does not delete a configuration from a host.
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
Delete an environment. Deleting an environment does not delete a configuration from a host.
Delete a version of a configuration from the AppConfig configuration store.
Retrieve information about an 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.
Retrieve information about a configuration profile.
Retrieve information about a configuration 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.
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.
Get information about a specific configuration version.
List all applications in your AWS account.
Lists the configuration profiles for an application.
List deployment strategies.
Lists the deployments for an environment.
List the environments for an application.
View a list of configurations stored in the AppConfig configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
Starts a 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.
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.
Deletes a tag key and value from an AppConfig resource.
Updates an application.
Updates a configuration profile.
Updates a deployment strategy.
Updates an environment.
Uses the validators in a configuration profile to validate a configuration.