The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::AppConfig

NAME

Paws::AppConfig - Perl Interface to AWS Amazon AppConfig

SYNOPSIS

  use Paws;

  my $obj = Paws->service('AppConfig');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS AppConfig

Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples.

  • Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.

  • Feature toggle: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.

  • Allow list: Use AppConfig to allow premium subscribers to access paid content.

  • Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.

This reference is intended to be used with the AWS AppConfig User Guide (http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09

METHODS

CreateApplication

Name => Str
[Description => Str]
[Tags => Paws::AppConfig::TagMap]

Each argument is described in detail in: Paws::AppConfig::CreateApplication

Returns: a Paws::AppConfig::Application instance

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

ApplicationId => Str
LocationUri => Str
Name => Str
[Description => Str]
[RetrievalRoleArn => Str]
[Tags => Paws::AppConfig::TagMap]
[Validators => ArrayRef[Paws::AppConfig::Validator]]

Each argument is described in detail in: Paws::AppConfig::CreateConfigurationProfile

Returns: a Paws::AppConfig::ConfigurationProfile instance

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 (http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html) in the AWS AppConfig User Guide.

CreateDeploymentStrategy

DeploymentDurationInMinutes => Int
GrowthFactor => Num
Name => Str
ReplicateTo => Str
[Description => Str]
[FinalBakeTimeInMinutes => Int]
[GrowthType => Str]
[Tags => Paws::AppConfig::TagMap]

Each argument is described in detail in: Paws::AppConfig::CreateDeploymentStrategy

Returns: a Paws::AppConfig::DeploymentStrategy instance

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

ApplicationId => Str
Name => Str
[Description => Str]
[Monitors => ArrayRef[Paws::AppConfig::Monitor]]
[Tags => Paws::AppConfig::TagMap]

Each argument is described in detail in: Paws::AppConfig::CreateEnvironment

Returns: a Paws::AppConfig::Environment instance

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

ApplicationId => Str
ConfigurationProfileId => Str
Content => Str
ContentType => Str
[Description => Str]
[LatestVersionNumber => Int]

Each argument is described in detail in: Paws::AppConfig::CreateHostedConfigurationVersion

Returns: a Paws::AppConfig::HostedConfigurationVersion instance

Create a new configuration in the AppConfig configuration store.

DeleteApplication

ApplicationId => Str

Each argument is described in detail in: Paws::AppConfig::DeleteApplication

Returns: nothing

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

DeleteConfigurationProfile

ApplicationId => Str
ConfigurationProfileId => Str

Each argument is described in detail in: Paws::AppConfig::DeleteConfigurationProfile

Returns: nothing

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

DeleteDeploymentStrategy

DeploymentStrategyId => Str

Each argument is described in detail in: Paws::AppConfig::DeleteDeploymentStrategy

Returns: nothing

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

DeleteEnvironment

ApplicationId => Str
EnvironmentId => Str

Each argument is described in detail in: Paws::AppConfig::DeleteEnvironment

Returns: nothing

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

DeleteHostedConfigurationVersion

ApplicationId => Str
ConfigurationProfileId => Str
VersionNumber => Int

Each argument is described in detail in: Paws::AppConfig::DeleteHostedConfigurationVersion

Returns: nothing

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

GetApplication

ApplicationId => Str

Each argument is described in detail in: Paws::AppConfig::GetApplication

Returns: a Paws::AppConfig::Application instance

Retrieve information about an application.

GetConfiguration

Application => Str
ClientId => Str
Configuration => Str
Environment => Str
[ClientConfigurationVersion => Str]

Each argument is described in detail in: Paws::AppConfig::GetConfiguration

Returns: a Paws::AppConfig::Configuration instance

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.

GetConfigurationProfile

ApplicationId => Str
ConfigurationProfileId => Str

Each argument is described in detail in: Paws::AppConfig::GetConfigurationProfile

Returns: a Paws::AppConfig::ConfigurationProfile instance

Retrieve information about a configuration profile.

GetDeployment

ApplicationId => Str
DeploymentNumber => Int
EnvironmentId => Str

Each argument is described in detail in: Paws::AppConfig::GetDeployment

Returns: a Paws::AppConfig::Deployment instance

Retrieve information about a configuration deployment.

GetDeploymentStrategy

DeploymentStrategyId => Str

Each argument is described in detail in: Paws::AppConfig::GetDeploymentStrategy

Returns: a Paws::AppConfig::DeploymentStrategy instance

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

ApplicationId => Str
EnvironmentId => Str

Each argument is described in detail in: Paws::AppConfig::GetEnvironment

Returns: a Paws::AppConfig::Environment instance

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

ApplicationId => Str
ConfigurationProfileId => Str
VersionNumber => Int

Each argument is described in detail in: Paws::AppConfig::GetHostedConfigurationVersion

Returns: a Paws::AppConfig::HostedConfigurationVersion instance

Get information about a specific configuration version.

ListApplications

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListApplications

Returns: a Paws::AppConfig::Applications instance

List all applications in your AWS account.

ListConfigurationProfiles

ApplicationId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListConfigurationProfiles

Returns: a Paws::AppConfig::ConfigurationProfiles instance

Lists the configuration profiles for an application.

ListDeployments

ApplicationId => Str
EnvironmentId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListDeployments

Returns: a Paws::AppConfig::Deployments instance

Lists the deployments for an environment.

ListDeploymentStrategies

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListDeploymentStrategies

Returns: a Paws::AppConfig::DeploymentStrategies instance

List deployment strategies.

ListEnvironments

ApplicationId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListEnvironments

Returns: a Paws::AppConfig::Environments instance

List the environments for an application.

ListHostedConfigurationVersions

ApplicationId => Str
ConfigurationProfileId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppConfig::ListHostedConfigurationVersions

Returns: a Paws::AppConfig::HostedConfigurationVersions instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::AppConfig::ListTagsForResource

Returns: a Paws::AppConfig::ResourceTags instance

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

StartDeployment

ApplicationId => Str
ConfigurationProfileId => Str
ConfigurationVersion => Str
DeploymentStrategyId => Str
EnvironmentId => Str
[Description => Str]
[Tags => Paws::AppConfig::TagMap]

Each argument is described in detail in: Paws::AppConfig::StartDeployment

Returns: a Paws::AppConfig::Deployment instance

Starts a deployment.

StopDeployment

ApplicationId => Str
DeploymentNumber => Int
EnvironmentId => Str

Each argument is described in detail in: Paws::AppConfig::StopDeployment

Returns: a Paws::AppConfig::Deployment instance

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

ResourceArn => Str
Tags => Paws::AppConfig::TagMap

Each argument is described in detail in: Paws::AppConfig::TagResource

Returns: nothing

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

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AppConfig::UntagResource

Returns: nothing

Deletes a tag key and value from an AppConfig resource.

UpdateApplication

ApplicationId => Str
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::AppConfig::UpdateApplication

Returns: a Paws::AppConfig::Application instance

Updates an application.

UpdateConfigurationProfile

ApplicationId => Str
ConfigurationProfileId => Str
[Description => Str]
[Name => Str]
[RetrievalRoleArn => Str]
[Validators => ArrayRef[Paws::AppConfig::Validator]]

Each argument is described in detail in: Paws::AppConfig::UpdateConfigurationProfile

Returns: a Paws::AppConfig::ConfigurationProfile instance

Updates a configuration profile.

UpdateDeploymentStrategy

DeploymentStrategyId => Str
[DeploymentDurationInMinutes => Int]
[Description => Str]
[FinalBakeTimeInMinutes => Int]
[GrowthFactor => Num]
[GrowthType => Str]

Each argument is described in detail in: Paws::AppConfig::UpdateDeploymentStrategy

Returns: a Paws::AppConfig::DeploymentStrategy instance

Updates a deployment strategy.

UpdateEnvironment

ApplicationId => Str
EnvironmentId => Str
[Description => Str]
[Monitors => ArrayRef[Paws::AppConfig::Monitor]]
[Name => Str]

Each argument is described in detail in: Paws::AppConfig::UpdateEnvironment

Returns: a Paws::AppConfig::Environment instance

Updates an environment.

ValidateConfiguration

ApplicationId => Str
ConfigurationProfileId => Str
ConfigurationVersion => Str

Each argument is described in detail in: Paws::AppConfig::ValidateConfiguration

Returns: nothing

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues