Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Proton.CreateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments in the AWS Proton Administrator Guide.

Synopsis

data CreateEnvironment = CreateEnvironment' {
- protonServiceRoleArn :: Maybe Text
- environmentAccountConnectionId :: Maybe Text
- templateMinorVersion :: Maybe Text
- description :: Maybe (Sensitive Text)
- tags :: Maybe [Tag]
- name :: Text
- spec :: Sensitive Text
- templateMajorVersion :: Text
- templateName :: Text
}
newCreateEnvironment :: Text -> Text -> Text -> Text -> CreateEnvironment
createEnvironment_protonServiceRoleArn :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_environmentAccountConnectionId :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_templateMinorVersion :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_tags :: Lens' CreateEnvironment (Maybe [Tag])
createEnvironment_name :: Lens' CreateEnvironment Text
createEnvironment_spec :: Lens' CreateEnvironment Text
createEnvironment_templateMajorVersion :: Lens' CreateEnvironment Text
createEnvironment_templateName :: Lens' CreateEnvironment Text
data CreateEnvironmentResponse = CreateEnvironmentResponse' {
- httpStatus :: Int
- environment :: Environment
}
newCreateEnvironmentResponse :: Int -> Environment -> CreateEnvironmentResponse
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
createEnvironmentResponse_environment :: Lens' CreateEnvironmentResponse Environment

Creating a Request

data CreateEnvironment Source #

See: newCreateEnvironment smart constructor.

Constructors

CreateEnvironment'

Fields

protonServiceRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.
environmentAccountConnectionId :: Maybe Text
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. For more information, see Environment account connections in the AWS Proton Administrator guide.
templateMinorVersion :: Maybe Text
The ID of the minor version of the environment template.
description :: Maybe (Sensitive Text)
A description of the environment that's being created and deployed.
tags :: Maybe [Tag]
Create tags for your environment. For more information, see /AWS Proton resources and tagging/ in the AWS Proton Administrator Guide or AWS Proton User Guide.
name :: Text
The name of the environment.
spec :: Sensitive Text
A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.
templateMajorVersion :: Text
The ID of the major version of the environment template.
templateName :: Text
The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.

Instances

Instances details

Eq CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods (==) :: CreateEnvironment -> CreateEnvironment -> Bool # (/=) :: CreateEnvironment -> CreateEnvironment -> Bool #
Show CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironment -> ShowS # show :: CreateEnvironment -> String # showList :: [CreateEnvironment] -> ShowS #
Generic CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Associated Types type Rep CreateEnvironment :: Type -> Type # Methods from :: CreateEnvironment -> Rep CreateEnvironment x # to :: Rep CreateEnvironment x -> CreateEnvironment #
NFData CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods rnf :: CreateEnvironment -> () #
Hashable CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods hashWithSalt :: Int -> CreateEnvironment -> Int # hash :: CreateEnvironment -> Int #
ToJSON CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods toJSON :: CreateEnvironment -> Value # toEncoding :: CreateEnvironment -> Encoding # toJSONList :: [CreateEnvironment] -> Value # toEncodingList :: [CreateEnvironment] -> Encoding #
AWSRequest CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Associated Types type AWSResponse CreateEnvironment # Methods request :: CreateEnvironment -> Request CreateEnvironment # response :: MonadResource m => Logger -> Service -> Proxy CreateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEnvironment))) #
ToHeaders CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods toHeaders :: CreateEnvironment -> [Header] #
ToPath CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods toPath :: CreateEnvironment -> ByteString #
ToQuery CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods toQuery :: CreateEnvironment -> QueryString #
type Rep CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment type Rep CreateEnvironment = D1 ('MetaData "CreateEnvironment" "Amazonka.Proton.CreateEnvironment" "libZSservicesZSamazonka-protonZSamazonka-proton" 'False) (C1 ('MetaCons "CreateEnvironment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "protonServiceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environmentAccountConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateMinorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: (S1 ('MetaSel ('Just "templateMajorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateEnvironment Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment type AWSResponse CreateEnvironment = CreateEnvironmentResponse

newCreateEnvironment Source #

Arguments

:: Text	`$sel:name:CreateEnvironment'`
-> Text	`$sel:spec:CreateEnvironment'`
-> Text	`$sel:templateMajorVersion:CreateEnvironment'`
-> Text	`$sel:templateName: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:protonServiceRoleArn:CreateEnvironment', createEnvironment_protonServiceRoleArn - The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.

$sel:environmentAccountConnectionId:CreateEnvironment', createEnvironment_environmentAccountConnectionId - The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. For more information, see Environment account connections in the AWS Proton Administrator guide.

$sel:templateMinorVersion:CreateEnvironment', createEnvironment_templateMinorVersion - The ID of the minor version of the environment template.

$sel:description:CreateEnvironment', createEnvironment_description - A description of the environment that's being created and deployed.

$sel:tags:CreateEnvironment', createEnvironment_tags - Create tags for your environment. For more information, see /AWS Proton resources and tagging/ in the AWS Proton Administrator Guide or AWS Proton User Guide.

$sel:name:CreateEnvironment', createEnvironment_name - The name of the environment.

$sel:spec:CreateEnvironment', createEnvironment_spec - A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.

$sel:templateMajorVersion:CreateEnvironment', createEnvironment_templateMajorVersion - The ID of the major version of the environment template.

$sel:templateName:CreateEnvironment', createEnvironment_templateName - The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.

Request Lenses

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

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.

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

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. For more information, see Environment account connections in the AWS Proton Administrator guide.

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

The ID of the minor version of the environment template.

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

A description of the environment that's being created and deployed.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe [Tag]) Source #

Create tags for your environment. For more information, see /AWS Proton resources and tagging/ in the AWS Proton Administrator Guide or AWS Proton User Guide.

createEnvironment_name :: Lens' CreateEnvironment Text Source #

The name of the environment.

createEnvironment_spec :: Lens' CreateEnvironment Text Source #

A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.

createEnvironment_templateMajorVersion :: Lens' CreateEnvironment Text Source #

The ID of the major version of the environment template.

createEnvironment_templateName :: Lens' CreateEnvironment Text Source #

The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.

Destructuring the Response

data CreateEnvironmentResponse Source #

See: newCreateEnvironmentResponse smart constructor.

Constructors

CreateEnvironmentResponse'
Fields httpStatus :: Int The response's http status code. environment :: Environment The environment detail data that's returned by AWS Proton.

Instances

Instances details

Eq CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods (==) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool # (/=) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool #
Show CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironmentResponse -> ShowS # show :: CreateEnvironmentResponse -> String # showList :: [CreateEnvironmentResponse] -> ShowS #
Generic CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Associated Types type Rep CreateEnvironmentResponse :: Type -> Type # Methods from :: CreateEnvironmentResponse -> Rep CreateEnvironmentResponse x # to :: Rep CreateEnvironmentResponse x -> CreateEnvironmentResponse #
NFData CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment Methods rnf :: CreateEnvironmentResponse -> () #
type Rep CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.Proton.CreateEnvironment type Rep CreateEnvironmentResponse = D1 ('MetaData "CreateEnvironmentResponse" "Amazonka.Proton.CreateEnvironment" "libZSservicesZSamazonka-protonZSamazonka-proton" 'False) (C1 ('MetaCons "CreateEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Environment)))

newCreateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEnvironmentResponse'`
-> Environment	`$sel:environment: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.

$sel:environment:CreateEnvironmentResponse', createEnvironmentResponse_environment - The environment detail data that's returned by AWS Proton.

Response Lenses

createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #

The response's http status code.

createEnvironmentResponse_environment :: Lens' CreateEnvironmentResponse Environment Source #

The environment detail data that's returned by AWS Proton.