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.M2.CreateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a runtime environment for a given runtime engine.

Synopsis

data CreateEnvironment = CreateEnvironment' {
- clientToken :: Maybe Text
- description :: Maybe Text
- engineVersion :: Maybe Text
- highAvailabilityConfig :: Maybe HighAvailabilityConfig
- kmsKeyId :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- publiclyAccessible :: Maybe Bool
- securityGroupIds :: Maybe [Text]
- storageConfigurations :: Maybe [StorageConfiguration]
- subnetIds :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- engineType :: EngineType
- instanceType :: Text
- name :: Text
}
newCreateEnvironment :: EngineType -> Text -> Text -> CreateEnvironment
createEnvironment_clientToken :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_engineVersion :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_highAvailabilityConfig :: Lens' CreateEnvironment (Maybe HighAvailabilityConfig)
createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_preferredMaintenanceWindow :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_publiclyAccessible :: Lens' CreateEnvironment (Maybe Bool)
createEnvironment_securityGroupIds :: Lens' CreateEnvironment (Maybe [Text])
createEnvironment_storageConfigurations :: Lens' CreateEnvironment (Maybe [StorageConfiguration])
createEnvironment_subnetIds :: Lens' CreateEnvironment (Maybe [Text])
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
createEnvironment_engineType :: Lens' CreateEnvironment EngineType
createEnvironment_instanceType :: Lens' CreateEnvironment Text
createEnvironment_name :: Lens' CreateEnvironment Text
data CreateEnvironmentResponse = CreateEnvironmentResponse' {
- httpStatus :: Int
- environmentId :: Text
}
newCreateEnvironmentResponse :: Int -> Text -> CreateEnvironmentResponse
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse Text

Creating a Request

data CreateEnvironment Source #

See: newCreateEnvironment smart constructor.

Constructors

CreateEnvironment'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
description :: Maybe Text
The description of the runtime environment.
engineVersion :: Maybe Text
The version of the engine type for the runtime environment.
highAvailabilityConfig :: Maybe HighAvailabilityConfig
The details of a high availability configuration for this runtime environment.
kmsKeyId :: Maybe Text
The identifier of a customer managed key.
preferredMaintenanceWindow :: Maybe Text
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
publiclyAccessible :: Maybe Bool
Specifies whether the runtime environment is publicly accessible.
securityGroupIds :: Maybe [Text]
The list of security groups for the VPC associated with this runtime environment.
storageConfigurations :: Maybe [StorageConfiguration]
Optional. The storage configurations for this runtime environment.
subnetIds :: Maybe [Text]
The list of subnets associated with the VPC for this runtime environment.
tags :: Maybe (HashMap Text Text)
The tags for the runtime environment.
engineType :: EngineType
The engine type for the runtime environment.
instanceType :: Text
The type of instance for the runtime environment.
name :: Text
The name of the runtime environment. Must be unique within the account.

Instances

Instances details

ToJSON CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods toJSON :: CreateEnvironment -> Value # toEncoding :: CreateEnvironment -> Encoding # toJSONList :: [CreateEnvironment] -> Value # toEncodingList :: [CreateEnvironment] -> Encoding #
ToHeaders CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods toHeaders :: CreateEnvironment -> [Header] #
ToPath CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods toPath :: CreateEnvironment -> ByteString #
ToQuery CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods toQuery :: CreateEnvironment -> QueryString #
AWSRequest CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Associated Types type AWSResponse CreateEnvironment # Methods request :: (Service -> Service) -> CreateEnvironment -> Request CreateEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEnvironment))) #
Generic CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Associated Types type Rep CreateEnvironment :: Type -> Type # Methods from :: CreateEnvironment -> Rep CreateEnvironment x # to :: Rep CreateEnvironment x -> CreateEnvironment #
Read CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods readsPrec :: Int -> ReadS CreateEnvironment # readList :: ReadS [CreateEnvironment] # readPrec :: ReadPrec CreateEnvironment # readListPrec :: ReadPrec [CreateEnvironment] #
Show CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironment -> ShowS # show :: CreateEnvironment -> String # showList :: [CreateEnvironment] -> ShowS #
NFData CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods rnf :: CreateEnvironment -> () #
Eq CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods (==) :: CreateEnvironment -> CreateEnvironment -> Bool # (/=) :: CreateEnvironment -> CreateEnvironment -> Bool #
Hashable CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods hashWithSalt :: Int -> CreateEnvironment -> Int # hash :: CreateEnvironment -> Int #
type AWSResponse CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment type AWSResponse CreateEnvironment = CreateEnvironmentResponse
type Rep CreateEnvironment Source #
Instance details Defined in Amazonka.M2.CreateEnvironment type Rep CreateEnvironment = D1 ('MetaData "CreateEnvironment" "Amazonka.M2.CreateEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "CreateEnvironment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "highAvailabilityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HighAvailabilityConfig)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "storageConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StorageConfiguration])) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EngineType)) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateEnvironment Source #

Arguments

:: EngineType	`CreateEnvironment`
-> Text	`CreateEnvironment`
-> Text	`CreateEnvironment`
-> CreateEnvironment

Create a value of CreateEnvironment 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:clientToken:CreateEnvironment', createEnvironment_clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

CreateEnvironment, createEnvironment_description - The description of the runtime environment.

CreateEnvironment, createEnvironment_engineVersion - The version of the engine type for the runtime environment.

$sel:highAvailabilityConfig:CreateEnvironment', createEnvironment_highAvailabilityConfig - The details of a high availability configuration for this runtime environment.

$sel:kmsKeyId:CreateEnvironment', createEnvironment_kmsKeyId - The identifier of a customer managed key.

$sel:preferredMaintenanceWindow:CreateEnvironment', createEnvironment_preferredMaintenanceWindow - Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

$sel:publiclyAccessible:CreateEnvironment', createEnvironment_publiclyAccessible - Specifies whether the runtime environment is publicly accessible.

$sel:securityGroupIds:CreateEnvironment', createEnvironment_securityGroupIds - The list of security groups for the VPC associated with this runtime environment.

$sel:storageConfigurations:CreateEnvironment', createEnvironment_storageConfigurations - Optional. The storage configurations for this runtime environment.

$sel:subnetIds:CreateEnvironment', createEnvironment_subnetIds - The list of subnets associated with the VPC for this runtime environment.

$sel:tags:CreateEnvironment', createEnvironment_tags - The tags for the runtime environment.

CreateEnvironment, createEnvironment_engineType - The engine type for the runtime environment.

CreateEnvironment, createEnvironment_instanceType - The type of instance for the runtime environment.

CreateEnvironment, createEnvironment_name - The name of the runtime environment. Must be unique within the account.

Request Lenses

createEnvironment_clientToken :: Lens' CreateEnvironment (Maybe Text) Source #

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #

The description of the runtime environment.

createEnvironment_engineVersion :: Lens' CreateEnvironment (Maybe Text) Source #

The version of the engine type for the runtime environment.

createEnvironment_highAvailabilityConfig :: Lens' CreateEnvironment (Maybe HighAvailabilityConfig) Source #

The details of a high availability configuration for this runtime environment.

createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text) Source #

The identifier of a customer managed key.

createEnvironment_preferredMaintenanceWindow :: Lens' CreateEnvironment (Maybe Text) Source #

Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

createEnvironment_publiclyAccessible :: Lens' CreateEnvironment (Maybe Bool) Source #

Specifies whether the runtime environment is publicly accessible.

createEnvironment_securityGroupIds :: Lens' CreateEnvironment (Maybe [Text]) Source #

The list of security groups for the VPC associated with this runtime environment.

createEnvironment_storageConfigurations :: Lens' CreateEnvironment (Maybe [StorageConfiguration]) Source #

Optional. The storage configurations for this runtime environment.

createEnvironment_subnetIds :: Lens' CreateEnvironment (Maybe [Text]) Source #

The list of subnets associated with the VPC for this runtime environment.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #

The tags for the runtime environment.

createEnvironment_engineType :: Lens' CreateEnvironment EngineType Source #

The engine type for the runtime environment.

createEnvironment_instanceType :: Lens' CreateEnvironment Text Source #

The type of instance for the runtime environment.

createEnvironment_name :: Lens' CreateEnvironment Text Source #

The name of the runtime environment. Must be unique within the account.

Destructuring the Response

data CreateEnvironmentResponse Source #

See: newCreateEnvironmentResponse smart constructor.

Constructors

CreateEnvironmentResponse'
Fields httpStatus :: Int The response's http status code. environmentId :: Text The unique identifier of the runtime environment.

Instances

Instances details

Generic CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Associated Types type Rep CreateEnvironmentResponse :: Type -> Type # Methods from :: CreateEnvironmentResponse -> Rep CreateEnvironmentResponse x # to :: Rep CreateEnvironmentResponse x -> CreateEnvironmentResponse #
Read CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods readsPrec :: Int -> ReadS CreateEnvironmentResponse # readList :: ReadS [CreateEnvironmentResponse] # readPrec :: ReadPrec CreateEnvironmentResponse # readListPrec :: ReadPrec [CreateEnvironmentResponse] #
Show CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironmentResponse -> ShowS # show :: CreateEnvironmentResponse -> String # showList :: [CreateEnvironmentResponse] -> ShowS #
NFData CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods rnf :: CreateEnvironmentResponse -> () #
Eq CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment Methods (==) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool # (/=) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool #
type Rep CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.CreateEnvironment type Rep CreateEnvironmentResponse = D1 ('MetaData "CreateEnvironmentResponse" "Amazonka.M2.CreateEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "CreateEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEnvironmentResponse'`
-> Text	`CreateEnvironmentResponse`
-> CreateEnvironmentResponse

Create a value of CreateEnvironmentResponse 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:httpStatus:CreateEnvironmentResponse', createEnvironmentResponse_httpStatus - The response's http status code.

CreateEnvironmentResponse, createEnvironmentResponse_environmentId - The unique identifier of the runtime environment.

Response Lenses

createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #

The response's http status code.

createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse Text Source #

The unique identifier of the runtime environment.