String applicationId
The application ID.
String id
The ID of the configuration profile.
String name
The name of the configuration profile.
String locationUri
The URI location of the configuration.
List<E> validatorTypes
The types of validators in the configuration profile.
String name
A name for the application.
String description
A description of the application.
Map<K,V> tags
Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
String applicationId
The application ID.
String name
A name for the configuration profile.
String description
A description of the configuration profile.
String locationUri
A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store
parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format
ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify
either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an
Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> .
Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<E> validators
A list of methods for validating the configuration.
Map<K,V> tags
Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
String applicationId
The application ID.
String id
The configuration profile ID.
String name
The name of the configuration profile.
String description
The configuration profile description.
String locationUri
The URI location of the configuration.
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<E> validators
A list of methods for validating the configuration.
String name
A name for the deployment strategy.
String description
A description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time for a deployment to last.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
String growthType
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the
value specified for Step percentage. For example, a linear deployment that uses a
Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments
are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the
targets have successfully received the configuration.
Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
G*(2^N). In this formula, G is the growth factor specified by the user and
N is the number of steps until the configuration is deployed to all targets. For example, if you
specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
String replicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
Map<K,V> tags
Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
String id
The deployment strategy ID.
String name
The name of the deployment strategy.
String description
The description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets that received a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String replicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
String applicationId
The application ID.
String name
A name for the environment.
String description
A description of the environment.
List<E> monitors
Amazon CloudWatch alarms to monitor during the deployment process.
Map<K,V> tags
Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
String applicationId
The application ID.
String id
The environment ID.
String name
The name of the environment.
String description
The description of the environment.
String state
The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
List<E> monitors
Amazon CloudWatch alarms monitored during the deployment.
String applicationId
The application ID.
String configurationProfileId
The configuration profile ID.
String description
A description of the configuration.
ByteBuffer content
The content of the configuration or the configuration data.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
Integer latestVersionNumber
An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version of the latest hosted configuration version.
String applicationId
The application ID.
String configurationProfileId
The configuration profile ID.
Integer versionNumber
The configuration version.
String description
A description of the configuration.
ByteBuffer content
The content of the configuration or the configuration data.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
String applicationId
The ID of the application to delete.
String deploymentStrategyId
The ID of the deployment strategy you want to delete.
String eventType
The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
String triggeredBy
The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
String description
A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
Date occurredAt
The date and time the event occurred.
String id
The deployment strategy ID.
String name
The name of the deployment strategy.
String description
The description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets that received a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String replicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
Integer deploymentNumber
The sequence number of the deployment.
String configurationName
The name of the configuration.
String configurationVersion
The version of the configuration.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grows over time.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String state
The state of the deployment.
Float percentageComplete
The percentage of targets for which the deployment is available.
Date startedAt
Time the deployment started.
Date completedAt
Time the deployment completed.
String applicationId
The application ID.
String id
The environment ID.
String name
The name of the environment.
String description
The description of the environment.
String state
The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
List<E> monitors
Amazon CloudWatch alarms monitored during the deployment.
String applicationId
The ID of the application you want to get.
String applicationId
The application ID.
String id
The configuration profile ID.
String name
The name of the configuration profile.
String description
The configuration profile description.
String locationUri
The URI location of the configuration.
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<E> validators
A list of methods for validating the configuration.
String application
The application to get. Specify either the application name or the application ID.
String environment
The environment to get. Specify either the environment name or the environment ID.
String configuration
The configuration to get. Specify either the configuration name or the configuration ID.
String clientId
A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
String clientConfigurationVersion
The configuration version returned in the most recent GetConfiguration response.
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.
For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.
ByteBuffer content
The content of the configuration or the configuration data.
String configurationVersion
The configuration version.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
String applicationId
The ID of the application that was deployed.
String environmentId
The ID of the environment that was deployed.
String deploymentStrategyId
The ID of the deployment strategy that was deployed.
String configurationProfileId
The ID of the configuration profile that was deployed.
Integer deploymentNumber
The sequence number of the deployment.
String configurationName
The name of the configuration.
String configurationLocationUri
Information about the source location of the configuration.
String configurationVersion
The configuration version that was deployed.
String description
The description of the deployment.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String state
The state of the deployment.
List<E> eventLog
A list containing all events related to a deployment. The most recent events are displayed first.
Float percentageComplete
The percentage of targets for which the deployment is available.
Date startedAt
The time the deployment started.
Date completedAt
The time the deployment completed.
String deploymentStrategyId
The ID of the deployment strategy to get.
String id
The deployment strategy ID.
String name
The name of the deployment strategy.
String description
The description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets that received a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String replicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
String applicationId
The application ID.
String id
The environment ID.
String name
The name of the environment.
String description
The description of the environment.
String state
The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
List<E> monitors
Amazon CloudWatch alarms monitored during the deployment.
String applicationId
The application ID.
String configurationProfileId
The configuration profile ID.
Integer versionNumber
The configuration version.
String description
A description of the configuration.
ByteBuffer content
The content of the configuration or the configuration data.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
String applicationId
The application ID.
String configurationProfileId
The configuration profile ID.
Integer versionNumber
The configuration version.
String description
A description of the configuration.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
String applicationId
The application ID.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
String applicationId
The application ID.
String environmentId
The environment ID.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
String applicationId
The application ID.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
String applicationId
The application ID.
String configurationProfileId
The configuration profile ID.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
String resourceArn
The resource ARN.
String resourceName
String applicationId
The application ID.
String environmentId
The environment ID.
String deploymentStrategyId
The deployment strategy ID.
String configurationProfileId
The configuration profile ID.
String configurationVersion
The configuration version to deploy.
String description
A description of the deployment.
Map<K,V> tags
Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
String applicationId
The ID of the application that was deployed.
String environmentId
The ID of the environment that was deployed.
String deploymentStrategyId
The ID of the deployment strategy that was deployed.
String configurationProfileId
The ID of the configuration profile that was deployed.
Integer deploymentNumber
The sequence number of the deployment.
String configurationName
The name of the configuration.
String configurationLocationUri
Information about the source location of the configuration.
String configurationVersion
The configuration version that was deployed.
String description
The description of the deployment.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String state
The state of the deployment.
List<E> eventLog
A list containing all events related to a deployment. The most recent events are displayed first.
Float percentageComplete
The percentage of targets for which the deployment is available.
Date startedAt
The time the deployment started.
Date completedAt
The time the deployment completed.
String applicationId
The ID of the application that was deployed.
String environmentId
The ID of the environment that was deployed.
String deploymentStrategyId
The ID of the deployment strategy that was deployed.
String configurationProfileId
The ID of the configuration profile that was deployed.
Integer deploymentNumber
The sequence number of the deployment.
String configurationName
The name of the configuration.
String configurationLocationUri
Information about the source location of the configuration.
String configurationVersion
The configuration version that was deployed.
String description
The description of the deployment.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String state
The state of the deployment.
List<E> eventLog
A list containing all events related to a deployment. The most recent events are displayed first.
Float percentageComplete
The percentage of targets for which the deployment is available.
Date startedAt
The time the deployment started.
Date completedAt
The time the deployment completed.
String applicationId
The application ID.
String configurationProfileId
The ID of the configuration profile.
String name
The name of the configuration profile.
String description
A description of the configuration profile.
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<E> validators
A list of methods for validating the configuration.
String applicationId
The application ID.
String id
The configuration profile ID.
String name
The name of the configuration profile.
String description
The configuration profile description.
String locationUri
The URI location of the configuration.
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<E> validators
A list of methods for validating the configuration.
String deploymentStrategyId
The deployment strategy ID.
String description
A description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time for a deployment to last.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
Float growthFactor
The percentage of targets to receive a deployed configuration during each interval.
String growthType
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.
Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
G*(2^N). In this formula, G is the growth factor specified by the user and
N is the number of steps until the configuration is deployed to all targets. For example, if you
specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
String id
The deployment strategy ID.
String name
The name of the deployment strategy.
String description
The description of the deployment strategy.
Integer deploymentDurationInMinutes
Total amount of time the deployment lasted.
String growthType
The algorithm used to define how percentage grew over time.
Float growthFactor
The percentage of targets that received a deployed configuration during each interval.
Integer finalBakeTimeInMinutes
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
String replicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
String applicationId
The application ID.
String environmentId
The environment ID.
String name
The name of the environment.
String description
A description of the environment.
List<E> monitors
Amazon CloudWatch alarms to monitor during the deployment process.
String applicationId
The application ID.
String id
The environment ID.
String name
The name of the environment.
String description
The description of the environment.
String state
The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
List<E> monitors
Amazon CloudWatch alarms monitored during the deployment.
Copyright © 2021. All rights reserved.