@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_PREFIXpublic CreateApplicationResult createApplication(CreateApplicationRequest request)
AmazonAppConfigCreates 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.
createApplication in interface AmazonAppConfigpublic CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest request)
AmazonAppConfigCreates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
Configuration data in SSM documents stored in the Systems Manager document store
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 AmazonAppConfigpublic CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest request)
AmazonAppConfigCreates 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 AmazonAppConfigpublic CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AmazonAppConfig
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.
createEnvironment in interface AmazonAppConfigpublic CreateExtensionResult createExtension(CreateExtensionRequest request)
AmazonAppConfigCreates 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.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For
an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and
processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored
notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for
the new extension version.
For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the
Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri
field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the
Uri field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
createExtension in interface AmazonAppConfigpublic CreateExtensionAssociationResult createExtensionAssociation(CreateExtensionAssociationRequest request)
AmazonAppConfig
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.
createExtensionAssociation in interface AmazonAppConfigpublic CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest request)
AmazonAppConfigCreates a new configuration in the AppConfig hosted configuration store.
createHostedConfigurationVersion in interface AmazonAppConfigpublic DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AmazonAppConfigDeletes an application. Deleting an application does not delete a configuration from a host.
deleteApplication in interface AmazonAppConfigpublic DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest request)
AmazonAppConfigDeletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfile in interface AmazonAppConfigpublic DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest request)
AmazonAppConfigDeletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategy in interface AmazonAppConfigpublic DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AmazonAppConfigDeletes an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironment in interface AmazonAppConfigpublic DeleteExtensionResult deleteExtension(DeleteExtensionRequest request)
AmazonAppConfigDeletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
deleteExtension in interface AmazonAppConfigpublic DeleteExtensionAssociationResult deleteExtensionAssociation(DeleteExtensionAssociationRequest request)
AmazonAppConfigDeletes an extension association. This action doesn't delete extensions defined in the association.
deleteExtensionAssociation in interface AmazonAppConfigpublic DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest request)
AmazonAppConfigDeletes a version of a configuration from the AppConfig hosted configuration store.
deleteHostedConfigurationVersion in interface AmazonAppConfigpublic GetApplicationResult getApplication(GetApplicationRequest request)
AmazonAppConfigRetrieves information about an application.
getApplication in interface AmazonAppConfig@Deprecated public GetConfigurationResult getConfiguration(GetConfigurationRequest request)
AmazonAppConfig(Deprecated) Retrieves the latest deployed configuration.
Note the following important information.
This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration is a priced call. For more information, see Pricing.
getConfiguration in interface AmazonAppConfigpublic GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest request)
AmazonAppConfigRetrieves information about a configuration profile.
getConfigurationProfile in interface AmazonAppConfigpublic GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonAppConfigRetrieves information about a configuration deployment.
getDeployment in interface AmazonAppConfigpublic GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest request)
AmazonAppConfigRetrieves 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 AmazonAppConfigpublic GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AmazonAppConfig
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.
getEnvironment in interface AmazonAppConfigpublic GetExtensionResult getExtension(GetExtensionRequest request)
AmazonAppConfigReturns information about an AppConfig extension.
getExtension in interface AmazonAppConfigpublic GetExtensionAssociationResult getExtensionAssociation(GetExtensionAssociationRequest request)
AmazonAppConfigReturns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
getExtensionAssociation in interface AmazonAppConfigpublic GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest request)
AmazonAppConfigRetrieves information about a specific configuration version.
getHostedConfigurationVersion in interface AmazonAppConfigpublic ListApplicationsResult listApplications(ListApplicationsRequest request)
AmazonAppConfigLists all applications in your Amazon Web Services account.
listApplications in interface AmazonAppConfigpublic ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest request)
AmazonAppConfigLists the configuration profiles for an application.
listConfigurationProfiles in interface AmazonAppConfigpublic ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest request)
AmazonAppConfigLists deployment strategies.
listDeploymentStrategies in interface AmazonAppConfigpublic ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
AmazonAppConfigLists the deployments for an environment in descending deployment number order.
listDeployments in interface AmazonAppConfigpublic ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AmazonAppConfigLists the environments for an application.
listEnvironments in interface AmazonAppConfigpublic ListExtensionAssociationsResult listExtensionAssociations(ListExtensionAssociationsRequest request)
AmazonAppConfigLists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
listExtensionAssociations in interface AmazonAppConfigpublic ListExtensionsResult listExtensions(ListExtensionsRequest request)
AmazonAppConfigLists 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.
listExtensions in interface AmazonAppConfigpublic ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest request)
AmazonAppConfigLists configurations stored in the AppConfig hosted configuration store by version.
listHostedConfigurationVersions in interface AmazonAppConfigpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonAppConfigRetrieves the list of key-value tags assigned to the resource.
listTagsForResource in interface AmazonAppConfigpublic StartDeploymentResult startDeployment(StartDeploymentRequest request)
AmazonAppConfigStarts a deployment.
startDeployment in interface AmazonAppConfigpublic 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 AmazonAppConfigpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonAppConfigAssigns 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 AmazonAppConfigpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonAppConfigDeletes a tag key and value from an AppConfig resource.
untagResource in interface AmazonAppConfigpublic UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AmazonAppConfigUpdates an application.
updateApplication in interface AmazonAppConfigpublic UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest request)
AmazonAppConfigUpdates a configuration profile.
updateConfigurationProfile in interface AmazonAppConfigpublic UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest request)
AmazonAppConfigUpdates a deployment strategy.
updateDeploymentStrategy in interface AmazonAppConfigpublic UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AmazonAppConfigUpdates an environment.
updateEnvironment in interface AmazonAppConfigpublic UpdateExtensionResult updateExtension(UpdateExtensionRequest request)
AmazonAppConfigUpdates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
updateExtension in interface AmazonAppConfigpublic UpdateExtensionAssociationResult updateExtensionAssociation(UpdateExtensionAssociationRequest request)
AmazonAppConfigUpdates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
updateExtensionAssociation in interface AmazonAppConfigpublic ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest request)
AmazonAppConfigUses the validators in a configuration profile to validate a configuration.
validateConfiguration in interface AmazonAppConfigpublic void shutdown()
AmazonAppConfigshutdown in interface AmazonAppConfigpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAppConfigResponse 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 AmazonAppConfigrequest - The originally executed request.