@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAppConfig extends Object implements AmazonAppConfig
AmazonAppConfig
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public CreateApplicationResult createApplication(CreateApplicationRequest request)
AmazonAppConfig
Creates an application. 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 Lambda, or any system you run on behalf of others.
createApplication
in interface AmazonAppConfig
public CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest request)
AmazonAppConfig
Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information:
The URI location of the configuration data.
The 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 Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
createConfigurationProfile
in interface AmazonAppConfig
public CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest request)
AmazonAppConfig
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.
createDeploymentStrategy
in interface AmazonAppConfig
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AmazonAppConfig
Creates an environment. 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.
createEnvironment
in interface AmazonAppConfig
public CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest request)
AmazonAppConfig
Creates a new configuration in the AppConfig hosted configuration store.
createHostedConfigurationVersion
in interface AmazonAppConfig
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AmazonAppConfig
Deletes an application. Deleting an application does not delete a configuration from a host.
deleteApplication
in interface AmazonAppConfig
public DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest request)
AmazonAppConfig
Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfile
in interface AmazonAppConfig
public DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest request)
AmazonAppConfig
Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategy
in interface AmazonAppConfig
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AmazonAppConfig
Deletes an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironment
in interface AmazonAppConfig
public DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest request)
AmazonAppConfig
Deletes a version of a configuration from the AppConfig hosted configuration store.
deleteHostedConfigurationVersion
in interface AmazonAppConfig
public GetApplicationResult getApplication(GetApplicationRequest request)
AmazonAppConfig
Retrieves information about an application.
getApplication
in interface AmazonAppConfig
@Deprecated public GetConfigurationResult getConfiguration(GetConfigurationRequest request)
AmazonAppConfig
Retrieves the latest deployed configuration.
Note the following important information.
This API action has been deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration
is a priced call. For more information, see Pricing.
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 you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
continue using GetConfiguration
, we recommend that you include the
ClientConfigurationVersion
value with every call to GetConfiguration
. The value to use
for ClientConfigurationVersion
comes from the ConfigurationVersion
attribute returned
by GetConfiguration
when there is new or updated data, and should be saved for subsequent calls to
GetConfiguration
.
getConfiguration
in interface AmazonAppConfig
public GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest request)
AmazonAppConfig
Retrieves information about a configuration profile.
getConfigurationProfile
in interface AmazonAppConfig
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonAppConfig
Retrieves information about a configuration deployment.
getDeployment
in interface AmazonAppConfig
public GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest request)
AmazonAppConfig
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.
getDeploymentStrategy
in interface AmazonAppConfig
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AmazonAppConfig
Retrieves 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.
getEnvironment
in interface AmazonAppConfig
public GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest request)
AmazonAppConfig
Retrieves information about a specific configuration version.
getHostedConfigurationVersion
in interface AmazonAppConfig
public ListApplicationsResult listApplications(ListApplicationsRequest request)
AmazonAppConfig
Lists all applications in your Amazon Web Services account.
listApplications
in interface AmazonAppConfig
public ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest request)
AmazonAppConfig
Lists the configuration profiles for an application.
listConfigurationProfiles
in interface AmazonAppConfig
public ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest request)
AmazonAppConfig
Lists deployment strategies.
listDeploymentStrategies
in interface AmazonAppConfig
public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
AmazonAppConfig
Lists the deployments for an environment in descending deployment number order.
listDeployments
in interface AmazonAppConfig
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AmazonAppConfig
Lists the environments for an application.
listEnvironments
in interface AmazonAppConfig
public ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest request)
AmazonAppConfig
Lists configurations stored in the AppConfig hosted configuration store by version.
listHostedConfigurationVersions
in interface AmazonAppConfig
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonAppConfig
Retrieves the list of key-value tags assigned to the resource.
listTagsForResource
in interface AmazonAppConfig
public StartDeploymentResult startDeployment(StartDeploymentRequest request)
AmazonAppConfig
Starts a deployment.
startDeployment
in interface AmazonAppConfig
public StopDeploymentResult stopDeployment(StopDeploymentRequest request)
AmazonAppConfig
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
.
stopDeployment
in interface AmazonAppConfig
public TagResourceResult tagResource(TagResourceRequest request)
AmazonAppConfig
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.
tagResource
in interface AmazonAppConfig
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonAppConfig
Deletes a tag key and value from an AppConfig resource.
untagResource
in interface AmazonAppConfig
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AmazonAppConfig
Updates an application.
updateApplication
in interface AmazonAppConfig
public UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest request)
AmazonAppConfig
Updates a configuration profile.
updateConfigurationProfile
in interface AmazonAppConfig
public UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest request)
AmazonAppConfig
Updates a deployment strategy.
updateDeploymentStrategy
in interface AmazonAppConfig
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AmazonAppConfig
Updates an environment.
updateEnvironment
in interface AmazonAppConfig
public ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest request)
AmazonAppConfig
Uses the validators in a configuration profile to validate a configuration.
validateConfiguration
in interface AmazonAppConfig
public void shutdown()
AmazonAppConfig
shutdown
in interface AmazonAppConfig
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAppConfig
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonAppConfig
request
- The originally executed request.