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 |
Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.
Synopsis
- data CreateApplication = CreateApplication' {}
- newCreateApplication :: Text -> Text -> ProxyType -> Text -> CreateApplication
- createApplication_apiGatewayProxy :: Lens' CreateApplication (Maybe ApiGatewayProxyInput)
- createApplication_clientToken :: Lens' CreateApplication (Maybe Text)
- createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text))
- createApplication_environmentIdentifier :: Lens' CreateApplication Text
- createApplication_name :: Lens' CreateApplication Text
- createApplication_proxyType :: Lens' CreateApplication ProxyType
- createApplication_vpcId :: Lens' CreateApplication Text
- data CreateApplicationResponse = CreateApplicationResponse' {
- apiGatewayProxy :: Maybe ApiGatewayProxyInput
- applicationId :: Maybe Text
- arn :: Maybe Text
- createdByAccountId :: Maybe Text
- createdTime :: Maybe POSIX
- environmentId :: Maybe Text
- lastUpdatedTime :: Maybe POSIX
- name :: Maybe Text
- ownerAccountId :: Maybe Text
- proxyType :: Maybe ProxyType
- state :: Maybe ApplicationState
- tags :: Maybe (Sensitive (HashMap Text Text))
- vpcId :: Maybe Text
- httpStatus :: Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- createApplicationResponse_apiGatewayProxy :: Lens' CreateApplicationResponse (Maybe ApiGatewayProxyInput)
- createApplicationResponse_applicationId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_arn :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_createdByAccountId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_createdTime :: Lens' CreateApplicationResponse (Maybe UTCTime)
- createApplicationResponse_environmentId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_lastUpdatedTime :: Lens' CreateApplicationResponse (Maybe UTCTime)
- createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_ownerAccountId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_proxyType :: Lens' CreateApplicationResponse (Maybe ProxyType)
- createApplicationResponse_state :: Lens' CreateApplicationResponse (Maybe ApplicationState)
- createApplicationResponse_tags :: Lens' CreateApplicationResponse (Maybe (HashMap Text Text))
- createApplicationResponse_vpcId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int
Creating a Request
data CreateApplication Source #
See: newCreateApplication
smart constructor.
CreateApplication' | |
|
Instances
:: Text | |
-> Text | |
-> ProxyType | |
-> Text | |
-> CreateApplication |
Create a value of CreateApplication
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:
CreateApplication
, createApplication_apiGatewayProxy
- A wrapper object holding the API Gateway endpoint type and stage name
for the proxy.
$sel:clientToken:CreateApplication'
, createApplication_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateApplication
, createApplication_tags
- The tags to assign to the application. A tag is a label that you assign
to an Amazon Web Services resource. Each tag consists of a key-value
pair.
$sel:environmentIdentifier:CreateApplication'
, createApplication_environmentIdentifier
- The unique identifier of the environment.
CreateApplication
, createApplication_name
- The name to use for the application.
CreateApplication
, createApplication_proxyType
- The proxy type of the proxy created within the application.
CreateApplication
, createApplication_vpcId
- The ID of the virtual private cloud (VPC).
Request Lenses
createApplication_apiGatewayProxy :: Lens' CreateApplication (Maybe ApiGatewayProxyInput) Source #
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
createApplication_clientToken :: Lens' CreateApplication (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #
The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
createApplication_environmentIdentifier :: Lens' CreateApplication Text Source #
The unique identifier of the environment.
createApplication_name :: Lens' CreateApplication Text Source #
The name to use for the application.
createApplication_proxyType :: Lens' CreateApplication ProxyType Source #
The proxy type of the proxy created within the application.
createApplication_vpcId :: Lens' CreateApplication Text Source #
The ID of the virtual private cloud (VPC).
Destructuring the Response
data CreateApplicationResponse Source #
See: newCreateApplicationResponse
smart constructor.
CreateApplicationResponse' | |
|
Instances
newCreateApplicationResponse Source #
Create a value of CreateApplicationResponse
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:
CreateApplication
, createApplicationResponse_apiGatewayProxy
- A wrapper object holding the API Gateway endpoint type and stage name
for the proxy.
CreateApplicationResponse
, createApplicationResponse_applicationId
- The unique identifier of the application.
CreateApplicationResponse
, createApplicationResponse_arn
- The Amazon Resource Name (ARN) of the application. The format for this
ARN is
arn:aws:refactor-spaces:
region
:
account-id
:
resource-type/resource-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the Amazon Web Services General Reference.
CreateApplicationResponse
, createApplicationResponse_createdByAccountId
- The Amazon Web Services account ID of application creator.
CreateApplicationResponse
, createApplicationResponse_createdTime
- A timestamp that indicates when the application is created.
CreateApplicationResponse
, createApplicationResponse_environmentId
- The ID of the environment in which the application is created.
CreateApplicationResponse
, createApplicationResponse_lastUpdatedTime
- A timestamp that indicates when the application was last updated.
CreateApplication
, createApplicationResponse_name
- The name of the application.
CreateApplicationResponse
, createApplicationResponse_ownerAccountId
- The Amazon Web Services account ID of the application owner (which is
always the same as the environment owner account ID).
CreateApplication
, createApplicationResponse_proxyType
- The proxy type of the proxy created within the application.
CreateApplicationResponse
, createApplicationResponse_state
- The current state of the application.
CreateApplication
, createApplicationResponse_tags
- The tags assigned to the application. A tag is a label that you assign
to an Amazon Web Services resource. Each tag consists of a key-value
pair.
CreateApplication
, createApplicationResponse_vpcId
- The ID of the Amazon VPC.
$sel:httpStatus:CreateApplicationResponse'
, createApplicationResponse_httpStatus
- The response's http status code.
Response Lenses
createApplicationResponse_apiGatewayProxy :: Lens' CreateApplicationResponse (Maybe ApiGatewayProxyInput) Source #
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
createApplicationResponse_applicationId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The unique identifier of the application.
createApplicationResponse_arn :: Lens' CreateApplicationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the application. The format for this
ARN is
arn:aws:refactor-spaces:
region
:
account-id
:
resource-type/resource-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the Amazon Web Services General Reference.
createApplicationResponse_createdByAccountId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The Amazon Web Services account ID of application creator.
createApplicationResponse_createdTime :: Lens' CreateApplicationResponse (Maybe UTCTime) Source #
A timestamp that indicates when the application is created.
createApplicationResponse_environmentId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The ID of the environment in which the application is created.
createApplicationResponse_lastUpdatedTime :: Lens' CreateApplicationResponse (Maybe UTCTime) Source #
A timestamp that indicates when the application was last updated.
createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text) Source #
The name of the application.
createApplicationResponse_ownerAccountId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
createApplicationResponse_proxyType :: Lens' CreateApplicationResponse (Maybe ProxyType) Source #
The proxy type of the proxy created within the application.
createApplicationResponse_state :: Lens' CreateApplicationResponse (Maybe ApplicationState) Source #
The current state of the application.
createApplicationResponse_tags :: Lens' CreateApplicationResponse (Maybe (HashMap Text Text)) Source #
The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
createApplicationResponse_vpcId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The ID of the Amazon VPC.
createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int Source #
The response's http status code.