/AWS1/CL_APCDEPLOYMENT¶
Deployment
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_applicationid TYPE /AWS1/APCID /AWS1/APCID¶
The ID of the application that was deployed.
iv_environmentid TYPE /AWS1/APCID /AWS1/APCID¶
The ID of the environment that was deployed.
iv_deploymentstrategyid TYPE /AWS1/APCID /AWS1/APCID¶
The ID of the deployment strategy that was deployed.
iv_configurationprofileid TYPE /AWS1/APCID /AWS1/APCID¶
The ID of the configuration profile that was deployed.
iv_deploymentnumber TYPE /AWS1/APCINTEGER /AWS1/APCINTEGER¶
The sequence number of the deployment.
iv_configurationname TYPE /AWS1/APCNAME /AWS1/APCNAME¶
The name of the configuration.
iv_configurationlocationuri TYPE /AWS1/APCURI /AWS1/APCURI¶
Information about the source location of the configuration.
iv_configurationversion TYPE /AWS1/APCVERSION /AWS1/APCVERSION¶
The configuration version that was deployed.
iv_description TYPE /AWS1/APCDESCRIPTION /AWS1/APCDESCRIPTION¶
The description of the deployment.
iv_deploymentdurinminutes TYPE /AWS1/APCMINSBETWEEN0AND24HO00 /AWS1/APCMINSBETWEEN0AND24HO00¶
Total amount of time the deployment lasted.
iv_growthtype TYPE /AWS1/APCGROWTHTYPE /AWS1/APCGROWTHTYPE¶
The algorithm used to define how percentage grew over time.
iv_growthfactor TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING¶
The percentage of targets to receive a deployed configuration during each interval.
iv_finalbaketimeinminutes TYPE /AWS1/APCMINSBETWEEN0AND24HO00 /AWS1/APCMINSBETWEEN0AND24HO00¶
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
iv_state TYPE /AWS1/APCDEPLOYMENTSTATE /AWS1/APCDEPLOYMENTSTATE¶
The state of the deployment.
it_eventlog TYPE /AWS1/CL_APCDEPLOYMENTEVENT=>TT_DEPLOYMENTEVENTS TT_DEPLOYMENTEVENTS¶
A list containing all events related to a deployment. The most recent events are displayed first.
iv_percentagecomplete TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING¶
The percentage of targets for which the deployment is available.
iv_startedat TYPE /AWS1/APCISO8601DATETIME /AWS1/APCISO8601DATETIME¶
The time the deployment started.
iv_completedat TYPE /AWS1/APCISO8601DATETIME /AWS1/APCISO8601DATETIME¶
The time the deployment completed.
it_appliedextensions TYPE /AWS1/CL_APCAPPLIEDEXTENSION=>TT_APPLIEDEXTENSIONS TT_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
StartDeploymentwas called.
iv_kmskeyarn TYPE /AWS1/APCARN /AWS1/APCARN¶
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.
iv_kmskeyidentifier TYPE /AWS1/APCKMSKEYIDENTIFIER /AWS1/APCKMSKEYIDENTIFIER¶
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
iv_versionlabel TYPE /AWS1/APCVERSIONLABEL /AWS1/APCVERSIONLABEL¶
A user-defined label for an AppConfig hosted configuration version.
Queryable Attributes¶
ApplicationId¶
The ID of the application that was deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
EnvironmentId¶
The ID of the environment that was deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTID() |
Getter for ENVIRONMENTID, with configurable default |
ASK_ENVIRONMENTID() |
Getter for ENVIRONMENTID w/ exceptions if field has no value |
HAS_ENVIRONMENTID() |
Determine if ENVIRONMENTID has a value |
DeploymentStrategyId¶
The ID of the deployment strategy that was deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTSTRATEGYID() |
Getter for DEPLOYMENTSTRATEGYID, with configurable default |
ASK_DEPLOYMENTSTRATEGYID() |
Getter for DEPLOYMENTSTRATEGYID w/ exceptions if field has n |
HAS_DEPLOYMENTSTRATEGYID() |
Determine if DEPLOYMENTSTRATEGYID has a value |
ConfigurationProfileId¶
The ID of the configuration profile that was deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATIONPROFILEID() |
Getter for CONFIGURATIONPROFILEID, with configurable default |
ASK_CONFIGURATIONPROFILEID() |
Getter for CONFIGURATIONPROFILEID w/ exceptions if field has |
HAS_CONFIGURATIONPROFILEID() |
Determine if CONFIGURATIONPROFILEID has a value |
DeploymentNumber¶
The sequence number of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTNUMBER() |
Getter for DEPLOYMENTNUMBER |
ConfigurationName¶
The name of the configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATIONNAME() |
Getter for CONFIGURATIONNAME, with configurable default |
ASK_CONFIGURATIONNAME() |
Getter for CONFIGURATIONNAME w/ exceptions if field has no v |
HAS_CONFIGURATIONNAME() |
Determine if CONFIGURATIONNAME has a value |
ConfigurationLocationUri¶
Information about the source location of the configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATIONLOCATIONURI() |
Getter for CONFIGURATIONLOCATIONURI, with configurable defau |
ASK_CONFIGURATIONLOCATIONURI() |
Getter for CONFIGURATIONLOCATIONURI w/ exceptions if field h |
HAS_CONFIGURATIONLOCATIONURI() |
Determine if CONFIGURATIONLOCATIONURI has a value |
ConfigurationVersion¶
The configuration version that was deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATIONVERSION() |
Getter for CONFIGURATIONVERSION, with configurable default |
ASK_CONFIGURATIONVERSION() |
Getter for CONFIGURATIONVERSION w/ exceptions if field has n |
HAS_CONFIGURATIONVERSION() |
Determine if CONFIGURATIONVERSION has a value |
Description¶
The description of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
DeploymentDurationInMinutes¶
Total amount of time the deployment lasted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTDURINMINUTES() |
Getter for DEPLOYMENTDURATIONINMINUTES |
GrowthType¶
The algorithm used to define how percentage grew over time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GROWTHTYPE() |
Getter for GROWTHTYPE, with configurable default |
ASK_GROWTHTYPE() |
Getter for GROWTHTYPE w/ exceptions if field has no value |
HAS_GROWTHTYPE() |
Determine if GROWTHTYPE has a value |
GrowthFactor¶
The percentage of targets to receive a deployed configuration during each interval.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GROWTHFACTOR() |
Getter for GROWTHFACTOR, with configurable default |
ASK_GROWTHFACTOR() |
Getter for GROWTHFACTOR w/ exceptions if field has no value |
STR_GROWTHFACTOR() |
String format for GROWTHFACTOR, with configurable default |
HAS_GROWTHFACTOR() |
Determine if GROWTHFACTOR has a value |
FinalBakeTimeInMinutes¶
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FINALBAKETIMEINMINUTES() |
Getter for FINALBAKETIMEINMINUTES |
State¶
The state of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
EventLog¶
A list containing all events related to a deployment. The most recent events are displayed first.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTLOG() |
Getter for EVENTLOG, with configurable default |
ASK_EVENTLOG() |
Getter for EVENTLOG w/ exceptions if field has no value |
HAS_EVENTLOG() |
Determine if EVENTLOG has a value |
PercentageComplete¶
The percentage of targets for which the deployment is available.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERCENTAGECOMPLETE() |
Getter for PERCENTAGECOMPLETE, with configurable default |
ASK_PERCENTAGECOMPLETE() |
Getter for PERCENTAGECOMPLETE w/ exceptions if field has no |
STR_PERCENTAGECOMPLETE() |
String format for PERCENTAGECOMPLETE, with configurable defa |
HAS_PERCENTAGECOMPLETE() |
Determine if PERCENTAGECOMPLETE has a value |
StartedAt¶
The time the deployment started.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTEDAT() |
Getter for STARTEDAT, with configurable default |
ASK_STARTEDAT() |
Getter for STARTEDAT w/ exceptions if field has no value |
HAS_STARTEDAT() |
Determine if STARTEDAT has a value |
CompletedAt¶
The time the deployment completed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPLETEDAT() |
Getter for COMPLETEDAT, with configurable default |
ASK_COMPLETEDAT() |
Getter for COMPLETEDAT w/ exceptions if field has no value |
HAS_COMPLETEDAT() |
Determine if COMPLETEDAT has a value |
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
StartDeploymentwas called.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLIEDEXTENSIONS() |
Getter for APPLIEDEXTENSIONS, with configurable default |
ASK_APPLIEDEXTENSIONS() |
Getter for APPLIEDEXTENSIONS w/ exceptions if field has no v |
HAS_APPLIEDEXTENSIONS() |
Determine if APPLIEDEXTENSIONS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYARN() |
Getter for KMSKEYARN, with configurable default |
ASK_KMSKEYARN() |
Getter for KMSKEYARN w/ exceptions if field has no value |
HAS_KMSKEYARN() |
Determine if KMSKEYARN has a value |
KmsKeyIdentifier¶
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYIDENTIFIER() |
Getter for KMSKEYIDENTIFIER, with configurable default |
ASK_KMSKEYIDENTIFIER() |
Getter for KMSKEYIDENTIFIER w/ exceptions if field has no va |
HAS_KMSKEYIDENTIFIER() |
Determine if KMSKEYIDENTIFIER has a value |
VersionLabel¶
A user-defined label for an AppConfig hosted configuration version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSIONLABEL() |
Getter for VERSIONLABEL, with configurable default |
ASK_VERSIONLABEL() |
Getter for VERSIONLABEL w/ exceptions if field has no value |
HAS_VERSIONLABEL() |
Determine if VERSIONLABEL has a value |