Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AppConfig

import { AppConfig } from "https://aws-api.deno.dev/v0.2/services/appconfig.ts?docs=full";
class AppConfig {
constructor(apiFactory: client.ApiFactory);
async createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<Application>;
async createConfigurationProfile(params: CreateConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>;
async createDeploymentStrategy(params: CreateDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>;
async createEnvironment(params: CreateEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>;
async createHostedConfigurationVersion(params: CreateHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersion>;
async deleteApplication(params: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteConfigurationProfile(params: DeleteConfigurationProfileRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDeploymentStrategy(params: DeleteDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteEnvironment(params: DeleteEnvironmentRequest, opts?: client.RequestOptions): Promise<void>;
async deleteHostedConfigurationVersion(params: DeleteHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<void>;
async getApplication(params: GetApplicationRequest, opts?: client.RequestOptions): Promise<Application>;
async getConfiguration(params: GetConfigurationRequest, opts?: client.RequestOptions): Promise<Configuration>;
async getConfigurationProfile(params: GetConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>;
async getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async getDeploymentStrategy(params: GetDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>;
async getEnvironment(params: GetEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>;
async getHostedConfigurationVersion(params: GetHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersion>;
async listApplications(params?: ListApplicationsRequest, opts?: client.RequestOptions): Promise<Applications>;
async listConfigurationProfiles(params: ListConfigurationProfilesRequest, opts?: client.RequestOptions): Promise<ConfigurationProfiles>;
async listDeployments(params: ListDeploymentsRequest, opts?: client.RequestOptions): Promise<Deployments>;
async listDeploymentStrategies(params?: ListDeploymentStrategiesRequest, opts?: client.RequestOptions): Promise<DeploymentStrategies>;
async listEnvironments(params: ListEnvironmentsRequest, opts?: client.RequestOptions): Promise<Environments>;
async listHostedConfigurationVersions(params: ListHostedConfigurationVersionsRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersions>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ResourceTags>;
async startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async stopDeployment(params: StopDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<Application>;
async updateConfigurationProfile(params: UpdateConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>;
async updateDeploymentStrategy(params: UpdateDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>;
async updateEnvironment(params: UpdateEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>;
async validateConfiguration(params: ValidateConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new AppConfig(apiFactory: client.ApiFactory)
[src]

§Methods

§
createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<Application>
[src]

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.

§
createConfigurationProfile(params: CreateConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>
[src]

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.

§
createDeploymentStrategy(params: CreateDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>
[src]

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.

§
createEnvironment(params: CreateEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>
[src]

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.

§
createHostedConfigurationVersion(params: CreateHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersion>
[src]

Create a new configuration in the AppConfig configuration store.

§
deleteApplication(params: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Delete an application. Deleting an application does not delete a configuration from a host.

§
deleteConfigurationProfile(params: DeleteConfigurationProfileRequest, opts?: client.RequestOptions): Promise<void>
[src]

Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

§
deleteDeploymentStrategy(params: DeleteDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

§
deleteEnvironment(params: DeleteEnvironmentRequest, opts?: client.RequestOptions): Promise<void>
[src]

Delete an environment. Deleting an environment does not delete a configuration from a host.

§
deleteHostedConfigurationVersion(params: DeleteHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<void>
[src]

Delete a version of a configuration from the AppConfig configuration store.

§
getApplication(params: GetApplicationRequest, opts?: client.RequestOptions): Promise<Application>
[src]

Retrieve information about an application.

§
getConfiguration(params: GetConfigurationRequest, opts?: client.RequestOptions): Promise<Configuration>
[src]

Receive information about a configuration.

! IMPORTANT: ! 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.

§
getConfigurationProfile(params: GetConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>
[src]

Retrieve information about a configuration profile.

§
getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

Retrieve information about a configuration deployment.

§
getDeploymentStrategy(params: GetDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>
[src]

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.

§
getEnvironment(params: GetEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>
[src]

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.

§
getHostedConfigurationVersion(params: GetHostedConfigurationVersionRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersion>
[src]

Get information about a specific configuration version.

§
listApplications(params?: ListApplicationsRequest, opts?: client.RequestOptions): Promise<Applications>
[src]

List all applications in your AWS account.

§
listConfigurationProfiles(params: ListConfigurationProfilesRequest, opts?: client.RequestOptions): Promise<ConfigurationProfiles>
[src]

Lists the configuration profiles for an application.

§
listDeployments(params: ListDeploymentsRequest, opts?: client.RequestOptions): Promise<Deployments>
[src]

Lists the deployments for an environment.

§
listDeploymentStrategies(params?: ListDeploymentStrategiesRequest, opts?: client.RequestOptions): Promise<DeploymentStrategies>
[src]

List deployment strategies.

§
listEnvironments(params: ListEnvironmentsRequest, opts?: client.RequestOptions): Promise<Environments>
[src]

List the environments for an application.

§
listHostedConfigurationVersions(params: ListHostedConfigurationVersionsRequest, opts?: client.RequestOptions): Promise<HostedConfigurationVersions>
[src]

View a list of configurations stored in the AppConfig configuration store by version.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ResourceTags>
[src]

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

§
startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

Starts a deployment.

§
stopDeployment(params: StopDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

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.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a tag key and value from an AppConfig resource.

§
updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<Application>
[src]

Updates an application.

§
updateConfigurationProfile(params: UpdateConfigurationProfileRequest, opts?: client.RequestOptions): Promise<ConfigurationProfile>
[src]

Updates a configuration profile.

§
updateDeploymentStrategy(params: UpdateDeploymentStrategyRequest, opts?: client.RequestOptions): Promise<DeploymentStrategy>
[src]

Updates a deployment strategy.

§
updateEnvironment(params: UpdateEnvironmentRequest, opts?: client.RequestOptions): Promise<Environment>
[src]

Updates an environment.

§
validateConfiguration(params: ValidateConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§Static Properties