| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppConfig.Types
Contents
- Service Configuration
- Errors
- ActionPoint
- DeploymentEventType
- DeploymentState
- EnvironmentState
- GrowthType
- ReplicateTo
- TriggeredBy
- ValidatorType
- Action
- ActionInvocation
- Application
- AppliedExtension
- ConfigurationProfile
- ConfigurationProfileSummary
- Deployment
- DeploymentEvent
- DeploymentStrategy
- DeploymentSummary
- Environment
- Extension
- ExtensionAssociation
- ExtensionAssociationSummary
- ExtensionSummary
- HostedConfigurationVersion
- HostedConfigurationVersionSummary
- Monitor
- Parameter
- Validator
Description
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _PayloadTooLargeException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- newtype ActionPoint where
- ActionPoint' { }
- pattern ActionPoint_ON_DEPLOYMENT_BAKING :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_COMPLETE :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_ROLLED_BACK :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_START :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_STEP :: ActionPoint
- pattern ActionPoint_PRE_CREATE_HOSTED_CONFIGURATION_VERSION :: ActionPoint
- pattern ActionPoint_PRE_START_DEPLOYMENT :: ActionPoint
- newtype DeploymentEventType where
- DeploymentEventType' { }
- pattern DeploymentEventType_BAKE_TIME_STARTED :: DeploymentEventType
- pattern DeploymentEventType_DEPLOYMENT_COMPLETED :: DeploymentEventType
- pattern DeploymentEventType_DEPLOYMENT_STARTED :: DeploymentEventType
- pattern DeploymentEventType_PERCENTAGE_UPDATED :: DeploymentEventType
- pattern DeploymentEventType_ROLLBACK_COMPLETED :: DeploymentEventType
- pattern DeploymentEventType_ROLLBACK_STARTED :: DeploymentEventType
- newtype DeploymentState where
- DeploymentState' { }
- pattern DeploymentState_BAKING :: DeploymentState
- pattern DeploymentState_COMPLETE :: DeploymentState
- pattern DeploymentState_DEPLOYING :: DeploymentState
- pattern DeploymentState_ROLLED_BACK :: DeploymentState
- pattern DeploymentState_ROLLING_BACK :: DeploymentState
- pattern DeploymentState_VALIDATING :: DeploymentState
- newtype EnvironmentState where
- EnvironmentState' { }
- pattern EnvironmentState_DEPLOYING :: EnvironmentState
- pattern EnvironmentState_READY_FOR_DEPLOYMENT :: EnvironmentState
- pattern EnvironmentState_ROLLED_BACK :: EnvironmentState
- pattern EnvironmentState_ROLLING_BACK :: EnvironmentState
- newtype GrowthType where
- GrowthType' { }
- pattern GrowthType_EXPONENTIAL :: GrowthType
- pattern GrowthType_LINEAR :: GrowthType
- newtype ReplicateTo where
- ReplicateTo' { }
- pattern ReplicateTo_NONE :: ReplicateTo
- pattern ReplicateTo_SSM_DOCUMENT :: ReplicateTo
- newtype TriggeredBy where
- TriggeredBy' { }
- pattern TriggeredBy_APPCONFIG :: TriggeredBy
- pattern TriggeredBy_CLOUDWATCH_ALARM :: TriggeredBy
- pattern TriggeredBy_INTERNAL_ERROR :: TriggeredBy
- pattern TriggeredBy_USER :: TriggeredBy
- newtype ValidatorType where
- ValidatorType' { }
- pattern ValidatorType_JSON_SCHEMA :: ValidatorType
- pattern ValidatorType_LAMBDA :: ValidatorType
- data Action = Action' {}
- newAction :: Action
- action_description :: Lens' Action (Maybe Text)
- action_name :: Lens' Action (Maybe Text)
- action_roleArn :: Lens' Action (Maybe Text)
- action_uri :: Lens' Action (Maybe Text)
- data ActionInvocation = ActionInvocation' {}
- newActionInvocation :: ActionInvocation
- actionInvocation_actionName :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_errorCode :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_errorMessage :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_extensionIdentifier :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_invocationId :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_roleArn :: Lens' ActionInvocation (Maybe Text)
- actionInvocation_uri :: Lens' ActionInvocation (Maybe Text)
- data Application = Application' {}
- newApplication :: Application
- application_description :: Lens' Application (Maybe Text)
- application_id :: Lens' Application (Maybe Text)
- application_name :: Lens' Application (Maybe Text)
- data AppliedExtension = AppliedExtension' {}
- newAppliedExtension :: AppliedExtension
- appliedExtension_extensionAssociationId :: Lens' AppliedExtension (Maybe Text)
- appliedExtension_extensionId :: Lens' AppliedExtension (Maybe Text)
- appliedExtension_parameters :: Lens' AppliedExtension (Maybe (HashMap Text Text))
- appliedExtension_versionNumber :: Lens' AppliedExtension (Maybe Int)
- data ConfigurationProfile = ConfigurationProfile' {
- applicationId :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- locationUri :: Maybe Text
- name :: Maybe Text
- retrievalRoleArn :: Maybe Text
- type' :: Maybe Text
- validators :: Maybe [Validator]
- newConfigurationProfile :: ConfigurationProfile
- configurationProfile_applicationId :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_id :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_type :: Lens' ConfigurationProfile (Maybe Text)
- configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator])
- data ConfigurationProfileSummary = ConfigurationProfileSummary' {
- applicationId :: Maybe Text
- id :: Maybe Text
- locationUri :: Maybe Text
- name :: Maybe Text
- type' :: Maybe Text
- validatorTypes :: Maybe [ValidatorType]
- newConfigurationProfileSummary :: ConfigurationProfileSummary
- configurationProfileSummary_applicationId :: Lens' ConfigurationProfileSummary (Maybe Text)
- configurationProfileSummary_id :: Lens' ConfigurationProfileSummary (Maybe Text)
- configurationProfileSummary_locationUri :: Lens' ConfigurationProfileSummary (Maybe Text)
- configurationProfileSummary_name :: Lens' ConfigurationProfileSummary (Maybe Text)
- configurationProfileSummary_type :: Lens' ConfigurationProfileSummary (Maybe Text)
- configurationProfileSummary_validatorTypes :: Lens' ConfigurationProfileSummary (Maybe [ValidatorType])
- data Deployment = Deployment' {
- applicationId :: Maybe Text
- appliedExtensions :: Maybe [AppliedExtension]
- completedAt :: Maybe ISO8601
- configurationLocationUri :: Maybe Text
- configurationName :: Maybe Text
- configurationProfileId :: Maybe Text
- configurationVersion :: Maybe Text
- deploymentDurationInMinutes :: Maybe Natural
- deploymentNumber :: Maybe Int
- deploymentStrategyId :: Maybe Text
- description :: Maybe Text
- environmentId :: Maybe Text
- eventLog :: Maybe [DeploymentEvent]
- finalBakeTimeInMinutes :: Maybe Natural
- growthFactor :: Maybe Double
- growthType :: Maybe GrowthType
- percentageComplete :: Maybe Double
- startedAt :: Maybe ISO8601
- state :: Maybe DeploymentState
- newDeployment :: Deployment
- deployment_applicationId :: Lens' Deployment (Maybe Text)
- deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension])
- deployment_completedAt :: Lens' Deployment (Maybe UTCTime)
- deployment_configurationLocationUri :: Lens' Deployment (Maybe Text)
- deployment_configurationName :: Lens' Deployment (Maybe Text)
- deployment_configurationProfileId :: Lens' Deployment (Maybe Text)
- deployment_configurationVersion :: Lens' Deployment (Maybe Text)
- deployment_deploymentDurationInMinutes :: Lens' Deployment (Maybe Natural)
- deployment_deploymentNumber :: Lens' Deployment (Maybe Int)
- deployment_deploymentStrategyId :: Lens' Deployment (Maybe Text)
- deployment_description :: Lens' Deployment (Maybe Text)
- deployment_environmentId :: Lens' Deployment (Maybe Text)
- deployment_eventLog :: Lens' Deployment (Maybe [DeploymentEvent])
- deployment_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural)
- deployment_growthFactor :: Lens' Deployment (Maybe Double)
- deployment_growthType :: Lens' Deployment (Maybe GrowthType)
- deployment_percentageComplete :: Lens' Deployment (Maybe Double)
- deployment_startedAt :: Lens' Deployment (Maybe UTCTime)
- deployment_state :: Lens' Deployment (Maybe DeploymentState)
- data DeploymentEvent = DeploymentEvent' {}
- newDeploymentEvent :: DeploymentEvent
- deploymentEvent_actionInvocations :: Lens' DeploymentEvent (Maybe [ActionInvocation])
- deploymentEvent_description :: Lens' DeploymentEvent (Maybe Text)
- deploymentEvent_eventType :: Lens' DeploymentEvent (Maybe DeploymentEventType)
- deploymentEvent_occurredAt :: Lens' DeploymentEvent (Maybe UTCTime)
- deploymentEvent_triggeredBy :: Lens' DeploymentEvent (Maybe TriggeredBy)
- data DeploymentStrategy = DeploymentStrategy' {}
- newDeploymentStrategy :: DeploymentStrategy
- deploymentStrategy_deploymentDurationInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
- deploymentStrategy_description :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_finalBakeTimeInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
- deploymentStrategy_growthFactor :: Lens' DeploymentStrategy (Maybe Double)
- deploymentStrategy_growthType :: Lens' DeploymentStrategy (Maybe GrowthType)
- deploymentStrategy_id :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_name :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_replicateTo :: Lens' DeploymentStrategy (Maybe ReplicateTo)
- data DeploymentSummary = DeploymentSummary' {
- completedAt :: Maybe ISO8601
- configurationName :: Maybe Text
- configurationVersion :: Maybe Text
- deploymentDurationInMinutes :: Maybe Natural
- deploymentNumber :: Maybe Int
- finalBakeTimeInMinutes :: Maybe Natural
- growthFactor :: Maybe Double
- growthType :: Maybe GrowthType
- percentageComplete :: Maybe Double
- startedAt :: Maybe ISO8601
- state :: Maybe DeploymentState
- newDeploymentSummary :: DeploymentSummary
- deploymentSummary_completedAt :: Lens' DeploymentSummary (Maybe UTCTime)
- deploymentSummary_configurationName :: Lens' DeploymentSummary (Maybe Text)
- deploymentSummary_configurationVersion :: Lens' DeploymentSummary (Maybe Text)
- deploymentSummary_deploymentDurationInMinutes :: Lens' DeploymentSummary (Maybe Natural)
- deploymentSummary_deploymentNumber :: Lens' DeploymentSummary (Maybe Int)
- deploymentSummary_finalBakeTimeInMinutes :: Lens' DeploymentSummary (Maybe Natural)
- deploymentSummary_growthFactor :: Lens' DeploymentSummary (Maybe Double)
- deploymentSummary_growthType :: Lens' DeploymentSummary (Maybe GrowthType)
- deploymentSummary_percentageComplete :: Lens' DeploymentSummary (Maybe Double)
- deploymentSummary_startedAt :: Lens' DeploymentSummary (Maybe UTCTime)
- deploymentSummary_state :: Lens' DeploymentSummary (Maybe DeploymentState)
- data Environment = Environment' {}
- newEnvironment :: Environment
- environment_applicationId :: Lens' Environment (Maybe Text)
- environment_description :: Lens' Environment (Maybe Text)
- environment_id :: Lens' Environment (Maybe Text)
- environment_monitors :: Lens' Environment (Maybe [Monitor])
- environment_name :: Lens' Environment (Maybe Text)
- environment_state :: Lens' Environment (Maybe EnvironmentState)
- data Extension = Extension' {}
- newExtension :: Extension
- extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action)))
- extension_arn :: Lens' Extension (Maybe Text)
- extension_description :: Lens' Extension (Maybe Text)
- extension_id :: Lens' Extension (Maybe Text)
- extension_name :: Lens' Extension (Maybe Text)
- extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter))
- extension_versionNumber :: Lens' Extension (Maybe Int)
- data ExtensionAssociation = ExtensionAssociation' {
- arn :: Maybe Text
- extensionArn :: Maybe Text
- extensionVersionNumber :: Maybe Int
- id :: Maybe Text
- parameters :: Maybe (HashMap Text Text)
- resourceArn :: Maybe Text
- newExtensionAssociation :: ExtensionAssociation
- extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text)
- extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text)
- extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int)
- extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text)
- extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text))
- extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text)
- data ExtensionAssociationSummary = ExtensionAssociationSummary' {
- extensionArn :: Maybe Text
- id :: Maybe Text
- resourceArn :: Maybe Text
- newExtensionAssociationSummary :: ExtensionAssociationSummary
- extensionAssociationSummary_extensionArn :: Lens' ExtensionAssociationSummary (Maybe Text)
- extensionAssociationSummary_id :: Lens' ExtensionAssociationSummary (Maybe Text)
- extensionAssociationSummary_resourceArn :: Lens' ExtensionAssociationSummary (Maybe Text)
- data ExtensionSummary = ExtensionSummary' {}
- newExtensionSummary :: ExtensionSummary
- extensionSummary_arn :: Lens' ExtensionSummary (Maybe Text)
- extensionSummary_description :: Lens' ExtensionSummary (Maybe Text)
- extensionSummary_id :: Lens' ExtensionSummary (Maybe Text)
- extensionSummary_name :: Lens' ExtensionSummary (Maybe Text)
- extensionSummary_versionNumber :: Lens' ExtensionSummary (Maybe Int)
- data HostedConfigurationVersion = HostedConfigurationVersion' {}
- newHostedConfigurationVersion :: HostedConfigurationVersion
- hostedConfigurationVersion_applicationId :: Lens' HostedConfigurationVersion (Maybe Text)
- hostedConfigurationVersion_configurationProfileId :: Lens' HostedConfigurationVersion (Maybe Text)
- hostedConfigurationVersion_content :: Lens' HostedConfigurationVersion (Maybe ByteString)
- hostedConfigurationVersion_contentType :: Lens' HostedConfigurationVersion (Maybe Text)
- hostedConfigurationVersion_description :: Lens' HostedConfigurationVersion (Maybe Text)
- hostedConfigurationVersion_versionNumber :: Lens' HostedConfigurationVersion (Maybe Int)
- data HostedConfigurationVersionSummary = HostedConfigurationVersionSummary' {}
- newHostedConfigurationVersionSummary :: HostedConfigurationVersionSummary
- hostedConfigurationVersionSummary_applicationId :: Lens' HostedConfigurationVersionSummary (Maybe Text)
- hostedConfigurationVersionSummary_configurationProfileId :: Lens' HostedConfigurationVersionSummary (Maybe Text)
- hostedConfigurationVersionSummary_contentType :: Lens' HostedConfigurationVersionSummary (Maybe Text)
- hostedConfigurationVersionSummary_description :: Lens' HostedConfigurationVersionSummary (Maybe Text)
- hostedConfigurationVersionSummary_versionNumber :: Lens' HostedConfigurationVersionSummary (Maybe Int)
- data Monitor = Monitor' {
- alarmRoleArn :: Maybe Text
- alarmArn :: Text
- newMonitor :: Text -> Monitor
- monitor_alarmRoleArn :: Lens' Monitor (Maybe Text)
- monitor_alarmArn :: Lens' Monitor Text
- data Parameter = Parameter' {}
- newParameter :: Parameter
- parameter_description :: Lens' Parameter (Maybe Text)
- parameter_required :: Lens' Parameter (Maybe Bool)
- data Validator = Validator' {}
- newValidator :: ValidatorType -> Text -> Validator
- validator_type :: Lens' Validator ValidatorType
- validator_content :: Lens' Validator Text
Service Configuration
defaultService :: Service Source #
API version 2019-10-09 of the Amazon AppConfig SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal failure in the AppConfig service.
_PayloadTooLargeException :: AsError a => Fold a ServiceError Source #
The configuration size is too large.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
ActionPoint
newtype ActionPoint Source #
Constructors
| ActionPoint' | |
Fields | |
Bundled Patterns
| pattern ActionPoint_ON_DEPLOYMENT_BAKING :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_COMPLETE :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_ROLLED_BACK :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_START :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_STEP :: ActionPoint | |
| pattern ActionPoint_PRE_CREATE_HOSTED_CONFIGURATION_VERSION :: ActionPoint | |
| pattern ActionPoint_PRE_START_DEPLOYMENT :: ActionPoint |
Instances
DeploymentEventType
newtype DeploymentEventType Source #
Constructors
| DeploymentEventType' | |
Fields | |
Bundled Patterns
Instances
DeploymentState
newtype DeploymentState Source #
Constructors
| DeploymentState' | |
Fields | |
Bundled Patterns
| pattern DeploymentState_BAKING :: DeploymentState | |
| pattern DeploymentState_COMPLETE :: DeploymentState | |
| pattern DeploymentState_DEPLOYING :: DeploymentState | |
| pattern DeploymentState_ROLLED_BACK :: DeploymentState | |
| pattern DeploymentState_ROLLING_BACK :: DeploymentState | |
| pattern DeploymentState_VALIDATING :: DeploymentState |
Instances
EnvironmentState
newtype EnvironmentState Source #
Constructors
| EnvironmentState' | |
Fields | |
Bundled Patterns
| pattern EnvironmentState_DEPLOYING :: EnvironmentState | |
| pattern EnvironmentState_READY_FOR_DEPLOYMENT :: EnvironmentState | |
| pattern EnvironmentState_ROLLED_BACK :: EnvironmentState | |
| pattern EnvironmentState_ROLLING_BACK :: EnvironmentState |
Instances
GrowthType
newtype GrowthType Source #
Constructors
| GrowthType' | |
Fields | |
Bundled Patterns
| pattern GrowthType_EXPONENTIAL :: GrowthType | |
| pattern GrowthType_LINEAR :: GrowthType |
Instances
ReplicateTo
newtype ReplicateTo Source #
Constructors
| ReplicateTo' | |
Fields | |
Bundled Patterns
| pattern ReplicateTo_NONE :: ReplicateTo | |
| pattern ReplicateTo_SSM_DOCUMENT :: ReplicateTo |
Instances
TriggeredBy
newtype TriggeredBy Source #
Constructors
| TriggeredBy' | |
Fields | |
Bundled Patterns
| pattern TriggeredBy_APPCONFIG :: TriggeredBy | |
| pattern TriggeredBy_CLOUDWATCH_ALARM :: TriggeredBy | |
| pattern TriggeredBy_INTERNAL_ERROR :: TriggeredBy | |
| pattern TriggeredBy_USER :: TriggeredBy |
Instances
ValidatorType
newtype ValidatorType Source #
Constructors
| ValidatorType' | |
Fields | |
Bundled Patterns
| pattern ValidatorType_JSON_SCHEMA :: ValidatorType | |
| pattern ValidatorType_LAMBDA :: ValidatorType |
Instances
Action
An action defines the tasks the extension performs during the AppConfig
workflow. Each action includes an action point such as
ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT.
Each action also includes a name, a URI to an Lambda function, and an
Amazon Resource Name (ARN) for an Identity and Access Management assume
role. You specify the name, URI, and ARN for each action point defined
in the extension. You can specify the following actions for an
extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK
See: newAction smart constructor.
Constructors
| Action' | |
Fields
| |
Instances
Create a value of Action with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Action', action_description - Information about the action.
$sel:name:Action', action_name - The action name.
$sel:roleArn:Action', action_roleArn - An Amazon Resource Name (ARN) for an Identity and Access Management
assume role.
$sel:uri:Action', action_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.
action_roleArn :: Lens' Action (Maybe Text) Source #
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
action_uri :: Lens' Action (Maybe Text) Source #
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.
ActionInvocation
data ActionInvocation Source #
An extension that was invoked as part of a deployment event.
See: newActionInvocation smart constructor.
Constructors
| ActionInvocation' | |
Fields
| |
Instances
newActionInvocation :: ActionInvocation Source #
Create a value of ActionInvocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionName:ActionInvocation', actionInvocation_actionName - The name of the action.
$sel:errorCode:ActionInvocation', actionInvocation_errorCode - The error code when an extension invocation fails.
$sel:errorMessage:ActionInvocation', actionInvocation_errorMessage - The error message when an extension invocation fails.
$sel:extensionIdentifier:ActionInvocation', actionInvocation_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
$sel:invocationId:ActionInvocation', actionInvocation_invocationId - A system-generated ID for this invocation.
$sel:roleArn:ActionInvocation', actionInvocation_roleArn - An Amazon Resource Name (ARN) for an Identity and Access Management
assume role.
$sel:uri:ActionInvocation', actionInvocation_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.
actionInvocation_actionName :: Lens' ActionInvocation (Maybe Text) Source #
The name of the action.
actionInvocation_errorCode :: Lens' ActionInvocation (Maybe Text) Source #
The error code when an extension invocation fails.
actionInvocation_errorMessage :: Lens' ActionInvocation (Maybe Text) Source #
The error message when an extension invocation fails.
actionInvocation_extensionIdentifier :: Lens' ActionInvocation (Maybe Text) Source #
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
actionInvocation_invocationId :: Lens' ActionInvocation (Maybe Text) Source #
A system-generated ID for this invocation.
actionInvocation_roleArn :: Lens' ActionInvocation (Maybe Text) Source #
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
actionInvocation_uri :: Lens' ActionInvocation (Maybe Text) Source #
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.
Application
data Application Source #
See: newApplication smart constructor.
Constructors
| Application' | |
Instances
newApplication :: Application Source #
Create a value of Application with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Application', application_description - The description of the application.
$sel:id:Application', application_id - The application ID.
$sel:name:Application', application_name - The application name.
application_description :: Lens' Application (Maybe Text) Source #
The description of the application.
application_id :: Lens' Application (Maybe Text) Source #
The application ID.
application_name :: Lens' Application (Maybe Text) Source #
The application name.
AppliedExtension
data AppliedExtension Source #
An extension that was invoked during a deployment.
See: newAppliedExtension smart constructor.
Constructors
| AppliedExtension' | |
Fields
| |
Instances
newAppliedExtension :: AppliedExtension Source #
Create a value of AppliedExtension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:extensionAssociationId:AppliedExtension', appliedExtension_extensionAssociationId - The system-generated ID for the association.
$sel:extensionId:AppliedExtension', appliedExtension_extensionId - The system-generated ID of the extension.
$sel:parameters:AppliedExtension', appliedExtension_parameters - One or more parameters for the actions called by the extension.
$sel:versionNumber:AppliedExtension', appliedExtension_versionNumber - The extension version number.
appliedExtension_extensionAssociationId :: Lens' AppliedExtension (Maybe Text) Source #
The system-generated ID for the association.
appliedExtension_extensionId :: Lens' AppliedExtension (Maybe Text) Source #
The system-generated ID of the extension.
appliedExtension_parameters :: Lens' AppliedExtension (Maybe (HashMap Text Text)) Source #
One or more parameters for the actions called by the extension.
appliedExtension_versionNumber :: Lens' AppliedExtension (Maybe Int) Source #
The extension version number.
ConfigurationProfile
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' | |
Fields
| |
Instances
newConfigurationProfile :: ConfigurationProfile Source #
Create a value of ConfigurationProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
ConfigurationProfile, configurationProfile_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
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
configurationProfile_applicationId :: Lens' ConfigurationProfile (Maybe Text) Source #
The application ID.
configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #
The configuration profile description.
configurationProfile_id :: Lens' ConfigurationProfile (Maybe Text) Source #
The configuration profile ID.
configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #
The URI location of the configuration.
configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #
The name of the configuration profile.
configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #
The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
configurationProfile_type :: Lens' ConfigurationProfile (Maybe Text) Source #
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
configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #
A list of methods for validating the configuration.
ConfigurationProfileSummary
data ConfigurationProfileSummary Source #
A summary of a configuration profile.
See: newConfigurationProfileSummary smart constructor.
Constructors
| ConfigurationProfileSummary' | |
Fields
| |
Instances
newConfigurationProfileSummary :: ConfigurationProfileSummary Source #
Create a value of ConfigurationProfileSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ConfigurationProfileSummary', configurationProfileSummary_applicationId - The application ID.
$sel:id:ConfigurationProfileSummary', configurationProfileSummary_id - The ID of the configuration profile.
$sel:locationUri:ConfigurationProfileSummary', configurationProfileSummary_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfileSummary', configurationProfileSummary_name - The name of the configuration profile.
$sel:type':ConfigurationProfileSummary', configurationProfileSummary_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
$sel:validatorTypes:ConfigurationProfileSummary', configurationProfileSummary_validatorTypes - The types of validators in the configuration profile.
configurationProfileSummary_applicationId :: Lens' ConfigurationProfileSummary (Maybe Text) Source #
The application ID.
configurationProfileSummary_id :: Lens' ConfigurationProfileSummary (Maybe Text) Source #
The ID of the configuration profile.
configurationProfileSummary_locationUri :: Lens' ConfigurationProfileSummary (Maybe Text) Source #
The URI location of the configuration.
configurationProfileSummary_name :: Lens' ConfigurationProfileSummary (Maybe Text) Source #
The name of the configuration profile.
configurationProfileSummary_type :: Lens' ConfigurationProfileSummary (Maybe Text) Source #
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
configurationProfileSummary_validatorTypes :: Lens' ConfigurationProfileSummary (Maybe [ValidatorType]) Source #
The types of validators in the configuration profile.
Deployment
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.
$sel:appliedExtensions:Deployment', deployment_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.
$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.
$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.
$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.
$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.
$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.
$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.
$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.
Deployment, deployment_description - The description of the deployment.
$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment that was deployed.
$sel:eventLog:Deployment', deployment_eventLog - A list containing all events related to a deployment. The most recent
events are displayed first.
$sel:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.
$sel:percentageComplete:Deployment', deployment_percentageComplete - The percentage of targets for which the deployment is available.
$sel:startedAt:Deployment', deployment_startedAt - The time the deployment started.
$sel:state:Deployment', deployment_state - The state of the deployment.
deployment_applicationId :: Lens' Deployment (Maybe Text) Source #
The ID of the application that was deployed.
deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension]) Source #
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.
deployment_completedAt :: Lens' Deployment (Maybe UTCTime) Source #
The time the deployment completed.
deployment_configurationLocationUri :: Lens' Deployment (Maybe Text) Source #
Information about the source location of the configuration.
deployment_configurationName :: Lens' Deployment (Maybe Text) Source #
The name of the configuration.
deployment_configurationProfileId :: Lens' Deployment (Maybe Text) Source #
The ID of the configuration profile that was deployed.
deployment_configurationVersion :: Lens' Deployment (Maybe Text) Source #
The configuration version that was deployed.
deployment_deploymentDurationInMinutes :: Lens' Deployment (Maybe Natural) Source #
Total amount of time the deployment lasted.
deployment_deploymentNumber :: Lens' Deployment (Maybe Int) Source #
The sequence number of the deployment.
deployment_deploymentStrategyId :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment strategy that was deployed.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description of the deployment.
deployment_environmentId :: Lens' Deployment (Maybe Text) Source #
The ID of the environment that was deployed.
deployment_eventLog :: Lens' Deployment (Maybe [DeploymentEvent]) Source #
A list containing all events related to a deployment. The most recent events are displayed first.
deployment_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural) Source #
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
deployment_growthFactor :: Lens' Deployment (Maybe Double) Source #
The percentage of targets to receive a deployed configuration during each interval.
deployment_growthType :: Lens' Deployment (Maybe GrowthType) Source #
The algorithm used to define how percentage grew over time.
deployment_percentageComplete :: Lens' Deployment (Maybe Double) Source #
The percentage of targets for which the deployment is available.
deployment_startedAt :: Lens' Deployment (Maybe UTCTime) Source #
The time the deployment started.
deployment_state :: Lens' Deployment (Maybe DeploymentState) Source #
The state of the deployment.
DeploymentEvent
data DeploymentEvent Source #
An object that describes a deployment event.
See: newDeploymentEvent smart constructor.
Constructors
| DeploymentEvent' | |
Fields
| |
Instances
newDeploymentEvent :: DeploymentEvent Source #
Create a value of DeploymentEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionInvocations:DeploymentEvent', deploymentEvent_actionInvocations - The list of extensions that were invoked as part of the deployment.
$sel:description:DeploymentEvent', deploymentEvent_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.
$sel:eventType:DeploymentEvent', deploymentEvent_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.
$sel:occurredAt:DeploymentEvent', deploymentEvent_occurredAt - The date and time the event occurred.
$sel:triggeredBy:DeploymentEvent', deploymentEvent_triggeredBy - The entity that triggered the deployment event. Events can be triggered
by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
deploymentEvent_actionInvocations :: Lens' DeploymentEvent (Maybe [ActionInvocation]) Source #
The list of extensions that were invoked as part of the deployment.
deploymentEvent_description :: Lens' DeploymentEvent (Maybe Text) Source #
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.
deploymentEvent_eventType :: Lens' DeploymentEvent (Maybe DeploymentEventType) Source #
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.
deploymentEvent_occurredAt :: Lens' DeploymentEvent (Maybe UTCTime) Source #
The date and time the event occurred.
deploymentEvent_triggeredBy :: Lens' DeploymentEvent (Maybe TriggeredBy) Source #
The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
DeploymentStrategy
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' | |
Fields
| |
Instances
newDeploymentStrategy :: DeploymentStrategy Source #
Create a value of DeploymentStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.
$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during
each interval.
$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.
$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.
$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.
$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
deploymentStrategy_deploymentDurationInMinutes :: Lens' DeploymentStrategy (Maybe Natural) Source #
Total amount of time the deployment lasted.
deploymentStrategy_description :: Lens' DeploymentStrategy (Maybe Text) Source #
The description of the deployment strategy.
deploymentStrategy_finalBakeTimeInMinutes :: Lens' DeploymentStrategy (Maybe Natural) Source #
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
deploymentStrategy_growthFactor :: Lens' DeploymentStrategy (Maybe Double) Source #
The percentage of targets that received a deployed configuration during each interval.
deploymentStrategy_growthType :: Lens' DeploymentStrategy (Maybe GrowthType) Source #
The algorithm used to define how percentage grew over time.
deploymentStrategy_id :: Lens' DeploymentStrategy (Maybe Text) Source #
The deployment strategy ID.
deploymentStrategy_name :: Lens' DeploymentStrategy (Maybe Text) Source #
The name of the deployment strategy.
deploymentStrategy_replicateTo :: Lens' DeploymentStrategy (Maybe ReplicateTo) Source #
Save the deployment strategy to a Systems Manager (SSM) document.
DeploymentSummary
data DeploymentSummary Source #
Information about the deployment.
See: newDeploymentSummary smart constructor.
Constructors
| DeploymentSummary' | |
Fields
| |
Instances
newDeploymentSummary :: DeploymentSummary Source #
Create a value of DeploymentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completedAt:DeploymentSummary', deploymentSummary_completedAt - Time the deployment completed.
$sel:configurationName:DeploymentSummary', deploymentSummary_configurationName - The name of the configuration.
$sel:configurationVersion:DeploymentSummary', deploymentSummary_configurationVersion - The version of the configuration.
$sel:deploymentDurationInMinutes:DeploymentSummary', deploymentSummary_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:DeploymentSummary', deploymentSummary_deploymentNumber - The sequence number of the deployment.
$sel:finalBakeTimeInMinutes:DeploymentSummary', deploymentSummary_finalBakeTimeInMinutes - The amount of time that AppConfig monitors for alarms before considering
the deployment to be complete and no longer eligible for automatic
rollback.
$sel:growthFactor:DeploymentSummary', deploymentSummary_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:DeploymentSummary', deploymentSummary_growthType - The algorithm used to define how percentage grows over time.
$sel:percentageComplete:DeploymentSummary', deploymentSummary_percentageComplete - The percentage of targets for which the deployment is available.
$sel:startedAt:DeploymentSummary', deploymentSummary_startedAt - Time the deployment started.
$sel:state:DeploymentSummary', deploymentSummary_state - The state of the deployment.
deploymentSummary_completedAt :: Lens' DeploymentSummary (Maybe UTCTime) Source #
Time the deployment completed.
deploymentSummary_configurationName :: Lens' DeploymentSummary (Maybe Text) Source #
The name of the configuration.
deploymentSummary_configurationVersion :: Lens' DeploymentSummary (Maybe Text) Source #
The version of the configuration.
deploymentSummary_deploymentDurationInMinutes :: Lens' DeploymentSummary (Maybe Natural) Source #
Total amount of time the deployment lasted.
deploymentSummary_deploymentNumber :: Lens' DeploymentSummary (Maybe Int) Source #
The sequence number of the deployment.
deploymentSummary_finalBakeTimeInMinutes :: Lens' DeploymentSummary (Maybe Natural) Source #
The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
deploymentSummary_growthFactor :: Lens' DeploymentSummary (Maybe Double) Source #
The percentage of targets to receive a deployed configuration during each interval.
deploymentSummary_growthType :: Lens' DeploymentSummary (Maybe GrowthType) Source #
The algorithm used to define how percentage grows over time.
deploymentSummary_percentageComplete :: Lens' DeploymentSummary (Maybe Double) Source #
The percentage of targets for which the deployment is available.
deploymentSummary_startedAt :: Lens' DeploymentSummary (Maybe UTCTime) Source #
Time the deployment started.
deploymentSummary_state :: Lens' DeploymentSummary (Maybe DeploymentState) Source #
The state of the deployment.
Environment
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' | |
Fields
| |
Instances
newEnvironment :: Environment Source #
Create a value of Environment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:Environment', environment_applicationId - The application ID.
$sel:description:Environment', environment_description - The description of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:name:Environment', environment_name - The name of the environment.
$sel:state:Environment', environment_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
environment_applicationId :: Lens' Environment (Maybe Text) Source #
The application ID.
environment_description :: Lens' Environment (Maybe Text) Source #
The description of the environment.
environment_id :: Lens' Environment (Maybe Text) Source #
The environment ID.
environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #
Amazon CloudWatch alarms monitored during the deployment.
environment_name :: Lens' Environment (Maybe Text) Source #
The name of the environment.
environment_state :: Lens' Environment (Maybe EnvironmentState) Source #
The state of the environment. An environment can be in one of the
following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK,
or ROLLED_BACK
Extension
See: newExtension smart constructor.
Constructors
| Extension' | |
Fields
| |
Instances
newExtension :: Extension Source #
Create a value of Extension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:Extension', extension_actions - The actions defined in the extension.
$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.
Extension, extension_description - Information about the extension.
$sel:id:Extension', extension_id - The system-generated ID of the extension.
Extension, extension_name - The extension name.
$sel:parameters:Extension', extension_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.
$sel:versionNumber:Extension', extension_versionNumber - The extension version number.
extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #
The actions defined in the extension.
extension_arn :: Lens' Extension (Maybe Text) Source #
The system-generated Amazon Resource Name (ARN) for the extension.
extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #
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.
ExtensionAssociation
data ExtensionAssociation Source #
See: newExtensionAssociation smart constructor.
Constructors
| ExtensionAssociation' | |
Fields
| |
Instances
newExtensionAssociation :: ExtensionAssociation Source #
Create a value of ExtensionAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.
$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.
$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.
$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.
$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #
The system-generated Amazon Resource Name (ARN) for the extension.
extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #
The ARN of the extension defined in the association.
extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #
The version number for the extension defined in the association.
extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #
The system-generated ID for the association.
extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #
The parameter names and values defined in the association.
extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #
The ARNs of applications, configuration profiles, or environments defined in the association.
ExtensionAssociationSummary
data ExtensionAssociationSummary Source #
Information about an association between an extension and an AppConfig
resource such as an application, environment, or configuration profile.
Call GetExtensionAssociation to get more information about an
association.
See: newExtensionAssociationSummary smart constructor.
Constructors
| ExtensionAssociationSummary' | |
Fields
| |
Instances
newExtensionAssociationSummary :: ExtensionAssociationSummary Source #
Create a value of ExtensionAssociationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:extensionArn:ExtensionAssociationSummary', extensionAssociationSummary_extensionArn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:id:ExtensionAssociationSummary', extensionAssociationSummary_id - The extension association ID. This ID is used to call other
ExtensionAssociation API actions such as GetExtensionAssociation or
DeleteExtensionAssociation.
$sel:resourceArn:ExtensionAssociationSummary', extensionAssociationSummary_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
extensionAssociationSummary_extensionArn :: Lens' ExtensionAssociationSummary (Maybe Text) Source #
The system-generated Amazon Resource Name (ARN) for the extension.
extensionAssociationSummary_id :: Lens' ExtensionAssociationSummary (Maybe Text) Source #
The extension association ID. This ID is used to call other
ExtensionAssociation API actions such as GetExtensionAssociation or
DeleteExtensionAssociation.
extensionAssociationSummary_resourceArn :: Lens' ExtensionAssociationSummary (Maybe Text) Source #
The ARNs of applications, configuration profiles, or environments defined in the association.
ExtensionSummary
data ExtensionSummary Source #
Information about an extension. Call GetExtension to get more
information about an extension.
See: newExtensionSummary smart constructor.
Constructors
| ExtensionSummary' | |
Instances
newExtensionSummary :: ExtensionSummary Source #
Create a value of ExtensionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ExtensionSummary', extensionSummary_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:description:ExtensionSummary', extensionSummary_description - Information about the extension.
$sel:id:ExtensionSummary', extensionSummary_id - The system-generated ID of the extension.
$sel:name:ExtensionSummary', extensionSummary_name - The extension name.
$sel:versionNumber:ExtensionSummary', extensionSummary_versionNumber - The extension version number.
extensionSummary_arn :: Lens' ExtensionSummary (Maybe Text) Source #
The system-generated Amazon Resource Name (ARN) for the extension.
extensionSummary_description :: Lens' ExtensionSummary (Maybe Text) Source #
Information about the extension.
extensionSummary_id :: Lens' ExtensionSummary (Maybe Text) Source #
The system-generated ID of the extension.
extensionSummary_name :: Lens' ExtensionSummary (Maybe Text) Source #
The extension name.
extensionSummary_versionNumber :: Lens' ExtensionSummary (Maybe Int) Source #
The extension version number.
HostedConfigurationVersion
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' | |
Fields
| |
Instances
newHostedConfigurationVersion :: HostedConfigurationVersion Source #
Create a value of HostedConfigurationVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
hostedConfigurationVersion_applicationId :: Lens' HostedConfigurationVersion (Maybe Text) Source #
The application ID.
hostedConfigurationVersion_configurationProfileId :: Lens' HostedConfigurationVersion (Maybe Text) Source #
The configuration profile ID.
hostedConfigurationVersion_content :: Lens' HostedConfigurationVersion (Maybe ByteString) Source #
The content of the configuration or the configuration data.
hostedConfigurationVersion_contentType :: Lens' HostedConfigurationVersion (Maybe Text) Source #
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
hostedConfigurationVersion_description :: Lens' HostedConfigurationVersion (Maybe Text) Source #
A description of the configuration.
hostedConfigurationVersion_versionNumber :: Lens' HostedConfigurationVersion (Maybe Int) Source #
The configuration version.
HostedConfigurationVersionSummary
data HostedConfigurationVersionSummary Source #
Information about the configuration.
See: newHostedConfigurationVersionSummary smart constructor.
Constructors
| HostedConfigurationVersionSummary' | |
Fields
| |
Instances
newHostedConfigurationVersionSummary :: HostedConfigurationVersionSummary Source #
Create a value of HostedConfigurationVersionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_applicationId - The application ID.
$sel:configurationProfileId:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_configurationProfileId - The configuration profile ID.
$sel:contentType:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:description:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_versionNumber - The configuration version.
hostedConfigurationVersionSummary_applicationId :: Lens' HostedConfigurationVersionSummary (Maybe Text) Source #
The application ID.
hostedConfigurationVersionSummary_configurationProfileId :: Lens' HostedConfigurationVersionSummary (Maybe Text) Source #
The configuration profile ID.
hostedConfigurationVersionSummary_contentType :: Lens' HostedConfigurationVersionSummary (Maybe Text) Source #
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
hostedConfigurationVersionSummary_description :: Lens' HostedConfigurationVersionSummary (Maybe Text) Source #
A description of the configuration.
hostedConfigurationVersionSummary_versionNumber :: Lens' HostedConfigurationVersionSummary (Maybe Int) Source #
The configuration version.
Monitor
Amazon CloudWatch alarms to monitor during the deployment process.
See: newMonitor smart constructor.
Constructors
| Monitor' | |
Fields
| |
Instances
| FromJSON Monitor Source # | |
| ToJSON Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| Generic Monitor Source # | |
| Read Monitor Source # | |
| Show Monitor Source # | |
| NFData Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| Eq Monitor Source # | |
| Hashable Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| type Rep Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor type Rep Monitor = D1 ('MetaData "Monitor" "Amazonka.AppConfig.Types.Monitor" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Monitor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Monitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmRoleArn:Monitor', monitor_alarmRoleArn - ARN of an Identity and Access Management (IAM) role for AppConfig to
monitor AlarmArn.
$sel:alarmArn:Monitor', monitor_alarmArn - Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
monitor_alarmRoleArn :: Lens' Monitor (Maybe Text) Source #
ARN of an Identity and Access Management (IAM) role for AppConfig to
monitor AlarmArn.
monitor_alarmArn :: Lens' Monitor Text Source #
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
Parameter
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
See: newParameter smart constructor.
Constructors
| Parameter' | |
Instances
| FromJSON Parameter Source # | |
| ToJSON Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| Generic Parameter Source # | |
| Read Parameter Source # | |
| Show Parameter Source # | |
| NFData Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| Eq Parameter Source # | |
| Hashable Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| type Rep Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.AppConfig.Types.Parameter" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) | |
newParameter :: Parameter Source #
Create a value of Parameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Parameter', parameter_description - Information about the parameter.
$sel:required:Parameter', parameter_required - A parameter value must be specified in the extension association.
parameter_required :: Lens' Parameter (Maybe Bool) Source #
A parameter value must be specified in the extension association.
Validator
A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
See: newValidator smart constructor.
Constructors
| Validator' | |
Fields
| |
Instances
| FromJSON Validator Source # | |
| ToJSON Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| Generic Validator Source # | |
| Show Validator Source # | |
| NFData Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| Eq Validator Source # | |
| Hashable Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| type Rep Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator type Rep Validator = D1 ('MetaData "Validator" "Amazonka.AppConfig.Types.Validator" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Validator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidatorType) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Arguments
| :: ValidatorType | |
| -> Text | |
| -> Validator |
Create a value of Validator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':Validator', validator_type - AppConfig supports validators of type JSON_SCHEMA and LAMBDA
$sel:content:Validator', validator_content - Either the JSON Schema content or the Amazon Resource Name (ARN) of an
Lambda function.
validator_type :: Lens' Validator ValidatorType Source #
AppConfig supports validators of type JSON_SCHEMA and LAMBDA