Network.AWS.APIGateway.CreateStage

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

Creating a Request

createStage

Arguments

:: Text

csRestAPIId

-> Text

csStageName

-> Text

csDeploymentId

-> 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:

• csVariables - 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-._~:/?#&=,]+ .
• csDocumentationVersion - The version of the associated API documentation.
• csCacheClusterSize - The stage's cache cluster size.
• csCacheClusterEnabled - Whether cache clustering is enabled for the stage.
• csDescription - The description of the Stage resource.
• csRestAPIId - The string identifier of the associated RestApi .
• csStageName - The name for the Stage resource.
• csDeploymentId - The identifier of the Deployment resource for the Stage resource.

data CreateStage

Requests Amazon API Gateway to create a Stage resource.

See: createStage smart constructor.

Instances

Eq CreateStage

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS CreateStage

readList :: ReadS [CreateStage]

readPrec :: ReadPrec CreateStage

readListPrec :: ReadPrec [CreateStage]

Show CreateStage

Methods

showsPrec :: Int -> CreateStage -> ShowS

show :: CreateStage -> String

showList :: [CreateStage] -> ShowS

Generic CreateStage

Associated Types

type Rep CreateStage :: * -> *

Methods

from :: CreateStage -> Rep CreateStage x

to :: Rep CreateStage x -> CreateStage

Hashable CreateStage

Methods

hashWithSalt :: Int -> CreateStage -> Int

hash :: CreateStage -> Int

ToJSON CreateStage

Methods

toJSON :: CreateStage -> Value

toEncoding :: CreateStage -> Encoding

toJSONList :: [CreateStage] -> Value

toEncodingList :: [CreateStage] -> Encoding

NFData CreateStage

Methods

rnf :: CreateStage -> ()

AWSRequest CreateStage

Associated Types

type Rs CreateStage :: *

Methods

request :: CreateStage -> Request CreateStage

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

ToQuery CreateStage

Methods

toQuery :: CreateStage -> QueryString

ToPath CreateStage

Methods

toPath :: CreateStage -> ByteString

ToHeaders CreateStage

Methods

toHeaders :: CreateStage -> [Header]

type Rep CreateStage

type Rep CreateStage = D1 (MetaData "CreateStage" "Network.AWS.APIGateway.CreateStage" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "CreateStage'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_csDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize))) (S1 (MetaSel (Just Symbol "_csCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_csStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateStage

type Rs CreateStage = Stage

Request Lenses

csVariables :: 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-._~:/?#&=,]+ .

csDocumentationVersion :: Lens' CreateStage (Maybe Text)

The version of the associated API documentation.

csCacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize)

The stage's cache cluster size.

csCacheClusterEnabled :: Lens' CreateStage (Maybe Bool)

Whether cache clustering is enabled for the stage.

csDescription :: Lens' CreateStage (Maybe Text)

The description of the Stage resource.

csRestAPIId :: Lens' CreateStage Text

The string identifier of the associated RestApi .

csStageName :: Lens' CreateStage Text

The name for the Stage resource.

csDeploymentId :: Lens' CreateStage Text

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-._~:/?#&=,]+ .
• 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.
• 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 Amazon API Gateway.
• sDescription - The stage's description.

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

Methods

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

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

Data Stage

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

Methods

readsPrec :: Int -> ReadS Stage

readList :: ReadS [Stage]

readPrec :: ReadPrec Stage

readListPrec :: ReadPrec [Stage]

Show Stage

Methods

showsPrec :: Int -> Stage -> ShowS

show :: Stage -> String

showList :: [Stage] -> ShowS

Generic Stage

Associated Types

type Rep Stage :: * -> *

Methods

from :: Stage -> Rep Stage x

to :: Rep Stage x -> Stage

Hashable Stage

Methods

hashWithSalt :: Int -> Stage -> Int

hash :: Stage -> Int

FromJSON Stage

Methods

parseJSON :: Value -> Parser Stage

parseJSONList :: Value -> Parser [Stage]

NFData Stage

Methods

rnf :: Stage -> ()

type Rep Stage

type Rep Stage = D1 (MetaData "Stage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Stage'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_sDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_sClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_sCacheClusterStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sMethodSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodSetting)))) ((:*:) (S1 (MetaSel (Just Symbol "_sLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_sCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize))))) ((:*:) (S1 (MetaSel (Just Symbol "_sCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_sStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe 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-._~:/?#&=,]+ .

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.

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 Amazon API Gateway.

sDescription :: Lens' Stage (Maybe Text)

The stage's description.