String name
The action name.
String description
Information about the action.
String uri
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
String roleArn
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
String extensionIdentifier
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
String actionName
The name of the action.
String uri
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
String roleArn
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
String errorMessage
The error message when an extension invocation fails.
String errorCode
The error code when an extension invocation fails.
String invocationId
A system-generated ID for this invocation.
String extensionId
The system-generated ID of the extension.
String extensionAssociationId
The system-generated ID for the association.
Integer versionNumber
The extension version number.
Map<K,V> parameters
One or more parameters for the actions called by the extension.
String reason
BadRequestDetails details
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 type
The type of configurations contained in the profile. AppConfig supports feature flags and
freeform configurations. We recommend you create feature flag configurations to enable or disable
new features and freeform configurations to distribute configurations to an application. When calling this API,
enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
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 the following:
For the AppConfig hosted configuration store and for feature flags, specify hosted.
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the
format ssm-parameter://<parameter name> or the ARN.
For an Secrets Manager secret, specify the URI in the following format: secrets-manager://<secret
name>.
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
For an SSM document, specify either the document name in the format
ssm-document://<document name> or the Amazon Resource Name (ARN).
String retrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
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 type
The type of configurations contained in the profile. AppConfig supports feature flags and
freeform configurations. We recommend you create feature flag configurations to enable or disable
new features and freeform configurations to distribute configurations to an application. When calling this API,
enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
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 type
The type of configurations contained in the profile. AppConfig supports feature flags and
freeform configurations. We recommend you create feature flag configurations to enable or disable
new features and freeform configurations to distribute configurations to an application. When calling this API,
enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
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
Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.
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. 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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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 extensionIdentifier
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
Integer extensionVersionNumber
The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.
String resourceIdentifier
The ARN of an application, configuration profile, or environment.
Map<K,V> parameters
The parameter names and values defined in the extensions. Extension parameters marked Required must
be entered for this field.
Map<K,V> tags
Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
String id
The system-generated ID for the association.
String extensionArn
The ARN of the extension defined in the association.
String resourceArn
The ARNs of applications, configuration profiles, or environments defined in the association.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
Map<K,V> parameters
The parameter names and values defined in the association.
Integer extensionVersionNumber
The version number for the extension defined in the association.
String name
A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.
String description
Information about the extension.
Map<K,V> actions
The actions defined in the extension.
Map<K,V> parameters
The parameters accepted by the extension. You specify parameter values when you associate the extension to an
AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
Map<K,V> tags
Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
Integer latestVersionNumber
You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
String id
The system-generated ID of the extension.
String name
The extension name.
Integer versionNumber
The extension version number.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
String description
Information about the extension.
Map<K,V> actions
The actions defined in the extension.
Map<K,V> parameters
The parameters accepted by the extension. You specify parameter values when you associate the extension to an
AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
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 number of the latest hosted configuration version.
String versionLabel
An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".
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 versionLabel
A user-defined label for an AppConfig hosted configuration version.
String applicationId
The ID of the application to delete.
String deploymentStrategyId
The ID of the deployment strategy you want to delete.
String extensionAssociationId
The ID of the extension association 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; and the start or completion of a rollback.
String triggeredBy
The entity that triggered the deployment event. Events can be triggered by a user, 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 Amazon 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.
List<E> actionInvocations
The list of extensions that were invoked as part of the 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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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 that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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 id
The extension association ID. This ID is used to call other ExtensionAssociation API actions such as
GetExtensionAssociation or DeleteExtensionAssociation.
String extensionArn
The system-generated Amazon Resource Name (ARN) for the extension.
String resourceArn
The ARNs of applications, configuration profiles, or environments defined in the association.
String id
The system-generated ID of the extension.
String name
The extension name.
Integer versionNumber
The extension version number.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
String description
Information about the extension.
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 type
The type of configurations contained in the profile. AppConfig supports feature flags and
freeform configurations. We recommend you create feature flag configurations to enable or disable
new features and freeform configurations to distribute configurations to an application. When calling this API,
enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
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
The clientId parameter in the following command is a unique, user-specified 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.
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 you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
continue using GetConfiguration, we recommend that you include the
ClientConfigurationVersion value with every call to GetConfiguration. The value to use
for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
GetConfiguration.
For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
ByteBuffer content
The content of the configuration or the configuration data.
The Content attribute only contains data if the system finds new or updated configuration data. If
there is no new or updated data and ClientConfigurationVersion matches the version of the current
configuration, AppConfig returns a 204 No Content HTTP response code and the Content
value will be empty.
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
List<E> appliedExtensions
A list of extensions that were processed as part of the deployment. The extensions that were previously
associated to the configuration profile, environment, or the application when StartDeployment was
called.
String kmsKeyArn
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
String kmsKeyIdentifier
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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 extensionAssociationId
The extension association ID to get.
String id
The system-generated ID for the association.
String extensionArn
The ARN of the extension defined in the association.
String resourceArn
The ARNs of applications, configuration profiles, or environments defined in the association.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
Map<K,V> parameters
The parameter names and values defined in the association.
Integer extensionVersionNumber
The version number for the extension defined in the association.
String id
The system-generated ID of the extension.
String name
The extension name.
Integer versionNumber
The extension version number.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
String description
Information about the extension.
Map<K,V> actions
The actions defined in the extension.
Map<K,V> parameters
The parameters accepted by the extension. You specify parameter values when you associate the extension to an
AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
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 versionLabel
A user-defined label for an AppConfig 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.
String contentType
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
String versionLabel
A user-defined label for an AppConfig hosted configuration version.
String constraint
The invalid or out-of-range validation constraint in your JSON schema that failed validation.
String location
Location of the validation constraint in the configuration JSON schema that failed validation.
String reason
The reason for an invalid configuration error.
String type
The type of error for an invalid configuration.
String value
Details about an error with Lambda when a synchronous extension experiences an error during an invocation.
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. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. 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 type
A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.
String applicationId
The application ID.
String environmentId
The environment ID.
Integer maxResults
The maximum number of items that may be returned for this call. If there are items that have not yet been
returned, the response will include a non-null NextToken that you can provide in a subsequent call
to get the next set of results.
String nextToken
The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first 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 resourceIdentifier
The ARN of an application, configuration profile, or environment.
String extensionIdentifier
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
Integer extensionVersionNumber
The version number for the extension defined in the association.
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 or pass null to get the first set of results.
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 name
The extension name.
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 versionLabel
An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.
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. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.
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 kmsKeyIdentifier
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
List<E> appliedExtensions
A list of extensions that were processed as part of the deployment. The extensions that were previously
associated to the configuration profile, environment, or the application when StartDeployment was
called.
String kmsKeyArn
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
String kmsKeyIdentifier
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
List<E> appliedExtensions
A list of extensions that were processed as part of the deployment. The extensions that were previously
associated to the configuration profile, environment, or the application when StartDeployment was
called.
String kmsKeyArn
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
String kmsKeyIdentifier
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
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 type
The type of configurations contained in the profile. AppConfig supports feature flags and
freeform configurations. We recommend you create feature flag configurations to enable or disable
new features and freeform configurations to distribute configurations to an application. When calling this API,
enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
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 that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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. 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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
String id
The system-generated ID for the association.
String extensionArn
The ARN of the extension defined in the association.
String resourceArn
The ARNs of applications, configuration profiles, or environments defined in the association.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
Map<K,V> parameters
The parameter names and values defined in the association.
Integer extensionVersionNumber
The version number for the extension defined in the association.
String extensionIdentifier
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
String description
Information about the extension.
Map<K,V> actions
The actions defined in the extension.
Map<K,V> parameters
One or more parameters for the actions called by the extension.
Integer versionNumber
The extension version number.
String id
The system-generated ID of the extension.
String name
The extension name.
Integer versionNumber
The extension version number.
String arn
The system-generated Amazon Resource Name (ARN) for the extension.
String description
Information about the extension.
Map<K,V> actions
The actions defined in the extension.
Map<K,V> parameters
The parameters accepted by the extension. You specify parameter values when you associate the extension to an
AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
Copyright © 2023. All rights reserved.