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.MigrationHubReFactorSpaces.CreateService

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.

If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.

Synopsis

data CreateService = CreateService' {
- clientToken :: Maybe Text
- description :: Maybe Text
- lambdaEndpoint :: Maybe LambdaEndpointInput
- tags :: Maybe (Sensitive (HashMap Text Text))
- urlEndpoint :: Maybe UrlEndpointInput
- vpcId :: Maybe Text
- applicationIdentifier :: Text
- endpointType :: ServiceEndpointType
- environmentIdentifier :: Text
- name :: Text
}
newCreateService :: Text -> ServiceEndpointType -> Text -> Text -> CreateService
createService_clientToken :: Lens' CreateService (Maybe Text)
createService_description :: Lens' CreateService (Maybe Text)
createService_lambdaEndpoint :: Lens' CreateService (Maybe LambdaEndpointInput)
createService_tags :: Lens' CreateService (Maybe (HashMap Text Text))
createService_urlEndpoint :: Lens' CreateService (Maybe UrlEndpointInput)
createService_vpcId :: Lens' CreateService (Maybe Text)
createService_applicationIdentifier :: Lens' CreateService Text
createService_endpointType :: Lens' CreateService ServiceEndpointType
createService_environmentIdentifier :: Lens' CreateService Text
createService_name :: Lens' CreateService Text
data CreateServiceResponse = CreateServiceResponse' {
- applicationId :: Maybe Text
- arn :: Maybe Text
- createdByAccountId :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- endpointType :: Maybe ServiceEndpointType
- environmentId :: Maybe Text
- lambdaEndpoint :: Maybe LambdaEndpointInput
- lastUpdatedTime :: Maybe POSIX
- name :: Maybe Text
- ownerAccountId :: Maybe Text
- serviceId :: Maybe Text
- state :: Maybe ServiceState
- tags :: Maybe (Sensitive (HashMap Text Text))
- urlEndpoint :: Maybe UrlEndpointInput
- vpcId :: Maybe Text
- httpStatus :: Int
}
newCreateServiceResponse :: Int -> CreateServiceResponse
createServiceResponse_applicationId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_arn :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_createdByAccountId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_createdTime :: Lens' CreateServiceResponse (Maybe UTCTime)
createServiceResponse_description :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_endpointType :: Lens' CreateServiceResponse (Maybe ServiceEndpointType)
createServiceResponse_environmentId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_lambdaEndpoint :: Lens' CreateServiceResponse (Maybe LambdaEndpointInput)
createServiceResponse_lastUpdatedTime :: Lens' CreateServiceResponse (Maybe UTCTime)
createServiceResponse_name :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_ownerAccountId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_serviceId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_state :: Lens' CreateServiceResponse (Maybe ServiceState)
createServiceResponse_tags :: Lens' CreateServiceResponse (Maybe (HashMap Text Text))
createServiceResponse_urlEndpoint :: Lens' CreateServiceResponse (Maybe UrlEndpointInput)
createServiceResponse_vpcId :: Lens' CreateServiceResponse (Maybe Text)
createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int

Creating a Request

data CreateService Source #

See: newCreateService smart constructor.

Constructors

CreateService'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
description :: Maybe Text
The description of the service.
lambdaEndpoint :: Maybe LambdaEndpointInput
The configuration for the Lambda endpoint type.
tags :: Maybe (Sensitive (HashMap Text Text))
The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
urlEndpoint :: Maybe UrlEndpointInput
The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.
vpcId :: Maybe Text
The ID of the VPC.
applicationIdentifier :: Text
The ID of the application which the service is created.
endpointType :: ServiceEndpointType
The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
environmentIdentifier :: Text
The ID of the environment in which the service is created.
name :: Text
The name of the service.

Instances

Instances details

ToJSON CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods toJSON :: CreateService -> Value # toEncoding :: CreateService -> Encoding # toJSONList :: [CreateService] -> Value # toEncodingList :: [CreateService] -> Encoding #
ToHeaders CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods toHeaders :: CreateService -> [Header] #
ToPath CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods toPath :: CreateService -> ByteString #
ToQuery CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods toQuery :: CreateService -> QueryString #
AWSRequest CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Associated Types type AWSResponse CreateService # Methods request :: (Service -> Service) -> CreateService -> Request CreateService # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateService -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateService))) #
Generic CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Associated Types type Rep CreateService :: Type -> Type # Methods from :: CreateService -> Rep CreateService x # to :: Rep CreateService x -> CreateService #
Show CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods showsPrec :: Int -> CreateService -> ShowS # show :: CreateService -> String # showList :: [CreateService] -> ShowS #
NFData CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods rnf :: CreateService -> () #
Eq CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods (==) :: CreateService -> CreateService -> Bool # (/=) :: CreateService -> CreateService -> Bool #
Hashable CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods hashWithSalt :: Int -> CreateService -> Int # hash :: CreateService -> Int #
type AWSResponse CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService type AWSResponse CreateService = CreateServiceResponse
type Rep CreateService Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService type Rep CreateService = D1 ('MetaData "CreateService" "Amazonka.MigrationHubReFactorSpaces.CreateService" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "CreateService'" '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 "lambdaEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaEndpointInput)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :: S1 ('MetaSel ('Just "urlEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UrlEndpointInput))))) :: ((S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "applicationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceEndpointType) :: (S1 ('MetaSel ('Just "environmentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateService Source #

Arguments

:: Text	`$sel:applicationIdentifier:CreateService'`
-> ServiceEndpointType	`CreateService`
-> Text	`$sel:environmentIdentifier:CreateService'`
-> Text	`CreateService`
-> CreateService

Create a value of CreateService 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:CreateService', createService_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateService, createService_description - The description of the service.

CreateService, createService_lambdaEndpoint - The configuration for the Lambda endpoint type.

CreateService, createService_tags - The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

CreateService, createService_urlEndpoint - The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.

CreateService, createService_vpcId - The ID of the VPC.

$sel:applicationIdentifier:CreateService', createService_applicationIdentifier - The ID of the application which the service is created.

CreateService, createService_endpointType - The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.

$sel:environmentIdentifier:CreateService', createService_environmentIdentifier - The ID of the environment in which the service is created.

CreateService, createService_name - The name of the service.

Request Lenses

createService_clientToken :: Lens' CreateService (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createService_description :: Lens' CreateService (Maybe Text) Source #

The description of the service.

createService_lambdaEndpoint :: Lens' CreateService (Maybe LambdaEndpointInput) Source #

The configuration for the Lambda endpoint type.

createService_tags :: Lens' CreateService (Maybe (HashMap Text Text)) Source #

The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

createService_urlEndpoint :: Lens' CreateService (Maybe UrlEndpointInput) Source #

The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.

createService_vpcId :: Lens' CreateService (Maybe Text) Source #

The ID of the VPC.

createService_applicationIdentifier :: Lens' CreateService Text Source #

The ID of the application which the service is created.

createService_endpointType :: Lens' CreateService ServiceEndpointType Source #

The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.

createService_environmentIdentifier :: Lens' CreateService Text Source #

The ID of the environment in which the service is created.

createService_name :: Lens' CreateService Text Source #

The name of the service.

Destructuring the Response

data CreateServiceResponse Source #

See: newCreateServiceResponse smart constructor.

Constructors

CreateServiceResponse'

Fields

applicationId :: Maybe Text
The ID of the application that the created service belongs to.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the service.
createdByAccountId :: Maybe Text
The Amazon Web Services account ID of the service creator.
createdTime :: Maybe POSIX
A timestamp that indicates when the service is created.
description :: Maybe Text
The description of the created service.
endpointType :: Maybe ServiceEndpointType
The endpoint type of the service.
environmentId :: Maybe Text
The unique identifier of the environment.
lambdaEndpoint :: Maybe LambdaEndpointInput
The configuration for the Lambda endpoint type.
lastUpdatedTime :: Maybe POSIX
A timestamp that indicates when the service was last updated.
name :: Maybe Text
The name of the service.
ownerAccountId :: Maybe Text
The Amazon Web Services account ID of the service owner.
serviceId :: Maybe Text
The unique identifier of the service.
state :: Maybe ServiceState
The current state of the service.
tags :: Maybe (Sensitive (HashMap Text Text))
The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
urlEndpoint :: Maybe UrlEndpointInput
The configuration for the URL endpoint type.
vpcId :: Maybe Text
The ID of the VPC.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateServiceResponse Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Associated Types type Rep CreateServiceResponse :: Type -> Type # Methods from :: CreateServiceResponse -> Rep CreateServiceResponse x # to :: Rep CreateServiceResponse x -> CreateServiceResponse #
Show CreateServiceResponse Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods showsPrec :: Int -> CreateServiceResponse -> ShowS # show :: CreateServiceResponse -> String # showList :: [CreateServiceResponse] -> ShowS #
NFData CreateServiceResponse Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods rnf :: CreateServiceResponse -> () #
Eq CreateServiceResponse Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService Methods (==) :: CreateServiceResponse -> CreateServiceResponse -> Bool # (/=) :: CreateServiceResponse -> CreateServiceResponse -> Bool #
type Rep CreateServiceResponse Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.CreateService type Rep CreateServiceResponse = D1 ('MetaData "CreateServiceResponse" "Amazonka.MigrationHubReFactorSpaces.CreateService" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "CreateServiceResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdByAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceEndpointType))) :: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lambdaEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaEndpointInput))))) :: (((S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceState)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "urlEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UrlEndpointInput)) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newCreateServiceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateServiceResponse'`
-> CreateServiceResponse

Create a value of CreateServiceResponse 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:

CreateServiceResponse, createServiceResponse_applicationId - The ID of the application that the created service belongs to.

CreateServiceResponse, createServiceResponse_arn - The Amazon Resource Name (ARN) of the service.

CreateServiceResponse, createServiceResponse_createdByAccountId - The Amazon Web Services account ID of the service creator.

CreateServiceResponse, createServiceResponse_createdTime - A timestamp that indicates when the service is created.

CreateService, createServiceResponse_description - The description of the created service.

CreateService, createServiceResponse_endpointType - The endpoint type of the service.

CreateServiceResponse, createServiceResponse_environmentId - The unique identifier of the environment.

CreateService, createServiceResponse_lambdaEndpoint - The configuration for the Lambda endpoint type.

CreateServiceResponse, createServiceResponse_lastUpdatedTime - A timestamp that indicates when the service was last updated.

CreateService, createServiceResponse_name - The name of the service.

CreateServiceResponse, createServiceResponse_ownerAccountId - The Amazon Web Services account ID of the service owner.

CreateServiceResponse, createServiceResponse_serviceId - The unique identifier of the service.

CreateServiceResponse, createServiceResponse_state - The current state of the service.

CreateService, createServiceResponse_tags - The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

CreateService, createServiceResponse_urlEndpoint - The configuration for the URL endpoint type.

CreateService, createServiceResponse_vpcId - The ID of the VPC.

$sel:httpStatus:CreateServiceResponse', createServiceResponse_httpStatus - The response's http status code.

Response Lenses

createServiceResponse_applicationId :: Lens' CreateServiceResponse (Maybe Text) Source #

The ID of the application that the created service belongs to.

createServiceResponse_arn :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service.

createServiceResponse_createdByAccountId :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service creator.

createServiceResponse_createdTime :: Lens' CreateServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service is created.

createServiceResponse_description :: Lens' CreateServiceResponse (Maybe Text) Source #

The description of the created service.

createServiceResponse_endpointType :: Lens' CreateServiceResponse (Maybe ServiceEndpointType) Source #

The endpoint type of the service.

createServiceResponse_environmentId :: Lens' CreateServiceResponse (Maybe Text) Source #

The unique identifier of the environment.

createServiceResponse_lambdaEndpoint :: Lens' CreateServiceResponse (Maybe LambdaEndpointInput) Source #

The configuration for the Lambda endpoint type.

createServiceResponse_lastUpdatedTime :: Lens' CreateServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service was last updated.

createServiceResponse_name :: Lens' CreateServiceResponse (Maybe Text) Source #

The name of the service.

createServiceResponse_ownerAccountId :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service owner.

createServiceResponse_serviceId :: Lens' CreateServiceResponse (Maybe Text) Source #

The unique identifier of the service.

createServiceResponse_state :: Lens' CreateServiceResponse (Maybe ServiceState) Source #

The current state of the service.

createServiceResponse_tags :: Lens' CreateServiceResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

createServiceResponse_urlEndpoint :: Lens' CreateServiceResponse (Maybe UrlEndpointInput) Source #

The configuration for the URL endpoint type.

createServiceResponse_vpcId :: Lens' CreateServiceResponse (Maybe Text) Source #

The ID of the VPC.

createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int Source #

The response's http status code.