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.4/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 createExtension(params: CreateExtensionRequest, opts?: client.RequestOptions): Promise<Extension>;
async createExtensionAssociation(params: CreateExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>;
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 deleteExtension(params: DeleteExtensionRequest, opts?: client.RequestOptions): Promise<void>;
async deleteExtensionAssociation(params: DeleteExtensionAssociationRequest, 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 getExtension(params: GetExtensionRequest, opts?: client.RequestOptions): Promise<Extension>;
async getExtensionAssociation(params: GetExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>;
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 listExtensionAssociations(params?: ListExtensionAssociationsRequest, opts?: client.RequestOptions): Promise<ExtensionAssociations>;
async listExtensions(params?: ListExtensionsRequest, opts?: client.RequestOptions): Promise<Extensions>;
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 updateExtension(params: UpdateExtensionRequest, opts?: client.RequestOptions): Promise<Extension>;
async updateExtensionAssociation(params: UpdateExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>;
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]

Creates 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.

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

Creates 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.

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

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.

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

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.

§
createExtension(params: CreateExtensionRequest, opts?: client.RequestOptions): Promise<Extension>
[src]

Creates 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 most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

§
createExtensionAssociation(params: CreateExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>
[src]

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 Working with AppConfig extensions in the AppConfig User Guide.

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

Creates a new configuration in the AppConfig hosted configuration store.

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

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

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

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

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

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

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

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

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

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

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

Deletes an extension association. This action doesn't delete extensions defined in the association.

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

Deletes a version of a configuration from the AppConfig hosted configuration store.

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

Retrieves information about an application.

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

(Deprecated) Retrieves the latest deployed configuration.

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

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

Retrieves information about a configuration profile.

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

Retrieves information about a configuration deployment.

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

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.

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

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.

§
getExtension(params: GetExtensionRequest, opts?: client.RequestOptions): Promise<Extension>
[src]

Returns information about an AppConfig extension.

§
getExtensionAssociation(params: GetExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>
[src]

Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

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

Retrieves information about a specific configuration version.

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

Lists all applications in your Amazon Web Services 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 in descending deployment number order.

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

Lists deployment strategies.

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

Lists the environments for an application.

§
listExtensionAssociations(params?: ListExtensionAssociationsRequest, opts?: client.RequestOptions): Promise<ExtensionAssociations>
[src]

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

§
listExtensions(params?: ListExtensionsRequest, opts?: client.RequestOptions): Promise<Extensions>
[src]

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

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

Lists configurations stored in the AppConfig hosted 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]

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.

§
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.

§
updateExtension(params: UpdateExtensionRequest, opts?: client.RequestOptions): Promise<Extension>
[src]

Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

§
updateExtensionAssociation(params: UpdateExtensionAssociationRequest, opts?: client.RequestOptions): Promise<ExtensionAssociation>
[src]

Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

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

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

§Static Properties