Network.AWS.APIGateway.CreateStage

Creates a new Stage resource that references a pre-existing Deployment for the API.

Creating a Request

createStage

Arguments

:: Text

cRestAPIId

-> Text

cStageName

-> Text

cDeploymentId

-> CreateStage

Creates a value of CreateStage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cVariables - A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .
• cDocumentationVersion - The version of the associated API documentation.
• cCacheClusterSize - The stage's cache cluster size.
• cCanarySettings - The canary deployment settings of this stage.
• cCacheClusterEnabled - Whether cache clustering is enabled for the stage.
• cDescription - The description of the Stage resource.
• cTags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.
• cRestAPIId - [Required] The string identifier of the associated RestApi .
• cStageName - [Required] The name for the Stage resource.
• cDeploymentId - [Required] The identifier of the Deployment resource for the Stage resource.

data CreateStage

Requests API Gateway to create a Stage resource.

See: createStage smart constructor.

Instances

Eq CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

(==) :: CreateStage -> CreateStage -> Bool

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

Data CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStage -> c CreateStage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStage

toConstr :: CreateStage -> Constr

dataTypeOf :: CreateStage -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStage)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStage)

gmapT :: (forall b. Data b => b -> b) -> CreateStage -> CreateStage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStage -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateStage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStage -> m CreateStage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStage -> m CreateStage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStage -> m CreateStage

Read CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

readsPrec :: Int -> ReadS CreateStage

readList :: ReadS [CreateStage]

readPrec :: ReadPrec CreateStage

readListPrec :: ReadPrec [CreateStage]

Show CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

showsPrec :: Int -> CreateStage -> ShowS

show :: CreateStage -> String

showList :: [CreateStage] -> ShowS

Generic CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Associated Types

type Rep CreateStage :: Type -> Type

Methods

from :: CreateStage -> Rep CreateStage x

to :: Rep CreateStage x -> CreateStage

Hashable CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

hashWithSalt :: Int -> CreateStage -> Int

hash :: CreateStage -> Int

ToJSON CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

toJSON :: CreateStage -> Value

toEncoding :: CreateStage -> Encoding

toJSONList :: [CreateStage] -> Value

toEncodingList :: [CreateStage] -> Encoding

AWSRequest CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Associated Types

type Rs CreateStage :: Type

Methods

request :: CreateStage -> Request CreateStage

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateStage -> ClientResponse -> m (Response CreateStage)

ToHeaders CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

toHeaders :: CreateStage -> [Header]

ToPath CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

toPath :: CreateStage -> ByteString

ToQuery CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

toQuery :: CreateStage -> QueryString

NFData CreateStage

Defined in Network.AWS.APIGateway.CreateStage

Methods

rnf :: CreateStage -> ()

type Rep CreateStage

Defined in Network.AWS.APIGateway.CreateStage

type Rep CreateStage = D1 (MetaData "CreateStage" "Network.AWS.APIGateway.CreateStage" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "CreateStage'" PrefixI True) (((S1 (MetaSel (Just "_cVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_cDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :*: (S1 (MetaSel (Just "_cCanarySettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CanarySettings)) :*: S1 (MetaSel (Just "_cCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 (MetaSel (Just "_cDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :*: (S1 (MetaSel (Just "_cRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_cStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateStage

Defined in Network.AWS.APIGateway.CreateStage

type Rs CreateStage = Stage

Request Lenses

cVariables :: Lens' CreateStage (HashMap Text Text)

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .

cDocumentationVersion :: Lens' CreateStage (Maybe Text)

The version of the associated API documentation.

cCacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize)

The stage's cache cluster size.

cCanarySettings :: Lens' CreateStage (Maybe CanarySettings)

The canary deployment settings of this stage.

cCacheClusterEnabled :: Lens' CreateStage (Maybe Bool)

Whether cache clustering is enabled for the stage.

cDescription :: Lens' CreateStage (Maybe Text)

The description of the Stage resource.

cTags :: Lens' CreateStage (HashMap Text Text)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

cRestAPIId :: Lens' CreateStage Text

Required

The string identifier of the associated RestApi .

cStageName :: Lens' CreateStage Text

Required

The name for the Stage resource.

cDeploymentId :: Lens' CreateStage Text

Required

The identifier of the Deployment resource for the Stage resource.

Destructuring the Response

stage :: Stage

Creates a value of Stage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDeploymentId - The identifier of the Deployment that the stage points to.
• sVariables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .
• sAccessLogSettings - Settings for logging access in this stage.
• sDocumentationVersion - The version of the associated API documentation.
• sClientCertificateId - The identifier of a client certificate for an API stage.
• sCreatedDate - The timestamp when the stage was created.
• sCacheClusterStatus - The status of the cache cluster for the stage, if enabled.
• sMethodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or ** for overriding all methods in the stage.
• sLastUpdatedDate - The timestamp when the stage last updated.
• sCacheClusterSize - The size of the cache cluster for the stage, if enabled.
• sCanarySettings - Settings for the canary deployment in this stage.
• sCacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.
• sStageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
• sDescription - The stage's description.
• sTags - The collection of tags. Each tag element is associated with a given resource.

data Stage

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

See: stage smart constructor.

Instances

Eq Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: Stage -> Stage -> Bool

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

Data Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Stage -> c Stage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Stage

toConstr :: Stage -> Constr

dataTypeOf :: Stage -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Stage)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Stage)

gmapT :: (forall b. Data b => b -> b) -> Stage -> Stage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Stage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Stage -> r

gmapQ :: (forall d. Data d => d -> u) -> Stage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Stage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Stage -> m Stage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Stage -> m Stage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Stage -> m Stage

Read Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS Stage

readList :: ReadS [Stage]

readPrec :: ReadPrec Stage

readListPrec :: ReadPrec [Stage]

Show Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> Stage -> ShowS

show :: Stage -> String

showList :: [Stage] -> ShowS

Generic Stage

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep Stage :: Type -> Type

Methods

from :: Stage -> Rep Stage x

to :: Rep Stage x -> Stage

Hashable Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> Stage -> Int

hash :: Stage -> Int

FromJSON Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser Stage

parseJSONList :: Value -> Parser [Stage]

NFData Stage

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: Stage -> ()

type Rep Stage

Defined in Network.AWS.APIGateway.Types.Product

type Rep Stage = D1 (MetaData "Stage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "Stage'" PrefixI True) (((S1 (MetaSel (Just "_sDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_sVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_sAccessLogSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AccessLogSettings)))) :*: ((S1 (MetaSel (Just "_sDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_sCacheClusterStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterStatus))))) :*: (((S1 (MetaSel (Just "_sMethodSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodSetting))) :*: S1 (MetaSel (Just "_sLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_sCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :*: S1 (MetaSel (Just "_sCanarySettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CanarySettings)))) :*: ((S1 (MetaSel (Just "_sCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_sStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))))

Response Lenses

sDeploymentId :: Lens' Stage (Maybe Text)

The identifier of the Deployment that the stage points to.

sVariables :: Lens' Stage (HashMap Text Text)

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .

sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings)

Settings for logging access in this stage.

sDocumentationVersion :: Lens' Stage (Maybe Text)

The version of the associated API documentation.

sClientCertificateId :: Lens' Stage (Maybe Text)

The identifier of a client certificate for an API stage.

sCreatedDate :: Lens' Stage (Maybe UTCTime)

The timestamp when the stage was created.

sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)

The status of the cache cluster for the stage, if enabled.

sMethodSettings :: Lens' Stage (HashMap Text MethodSetting)

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or ** for overriding all methods in the stage.

sLastUpdatedDate :: Lens' Stage (Maybe UTCTime)

The timestamp when the stage last updated.

sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)

The size of the cache cluster for the stage, if enabled.

sCanarySettings :: Lens' Stage (Maybe CanarySettings)

Settings for the canary deployment in this stage.

sCacheClusterEnabled :: Lens' Stage (Maybe Bool)

Specifies whether a cache cluster is enabled for the stage.

sStageName :: Lens' Stage (Maybe Text)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

sDescription :: Lens' Stage (Maybe Text)

The stage's description.

sTags :: Lens' Stage (HashMap Text Text)

The collection of tags. Each tag element is associated with a given resource.