Amazonka.ApiGatewayV2.Types.Deployment

Documentation

data Deployment

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

See: newDeployment smart constructor.

Constructors

Deployment'

Fields

• autoDeployed :: Maybe Bool

  Specifies whether a deployment was automatically released.

• createdDate :: Maybe ISO8601

  The date and time when the Deployment resource was created.

• deploymentId :: Maybe Text

  The identifier for the deployment.

• deploymentStatus :: Maybe DeploymentStatus

  The status of the deployment: PENDING, FAILED, or SUCCEEDED.

• deploymentStatusMessage :: Maybe Text

  May contain additional feedback on the status of an API deployment.

• description :: Maybe Text

  The description for the deployment.

Instances

FromJSON Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

Generic Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Read Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

NFData Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

rnf :: Deployment -> ()

Eq Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

(/=) :: Deployment -> Deployment -> Bool

Hashable Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

type Rep Deployment

Defined in Amazonka.ApiGatewayV2.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.ApiGatewayV2.Types.Deployment" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoDeployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStatus)) :*: (S1 ('MetaSel ('Just "deploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDeployment :: Deployment

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:autoDeployed:Deployment', deployment_autoDeployed - Specifies whether a deployment was automatically released.

$sel:createdDate:Deployment', deployment_createdDate - The date and time when the Deployment resource was created.

$sel:deploymentId:Deployment', deployment_deploymentId - The identifier for the deployment.

$sel:deploymentStatus:Deployment', deployment_deploymentStatus - The status of the deployment: PENDING, FAILED, or SUCCEEDED.

$sel:deploymentStatusMessage:Deployment', deployment_deploymentStatusMessage - May contain additional feedback on the status of an API deployment.

$sel:description:Deployment', deployment_description - The description for the deployment.

deployment_autoDeployed :: Lens' Deployment (Maybe Bool)

Specifies whether a deployment was automatically released.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime)

The date and time when the Deployment resource was created.

deployment_deploymentId :: Lens' Deployment (Maybe Text)

The identifier for the deployment.

deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus)

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

deployment_deploymentStatusMessage :: Lens' Deployment (Maybe Text)

May contain additional feedback on the status of an API deployment.

deployment_description :: Lens' Deployment (Maybe Text)

The description for the deployment.