String apiGatewayId
The resource ID of the API Gateway for the proxy.
String endpointType
The type of API Gateway endpoint created.
String nlbArn
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
String nlbName
The name of the Network Load Balancer that is configured by the API Gateway proxy.
String proxyUrl
The endpoint URL of the API Gateway proxy.
String stageName
The name of the API Gateway stage. The name defaults to prod.
String vpcLinkId
The VpcLink ID of the API Gateway proxy.
String endpointType
The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set
to REGIONAL by default.
If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated
from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon
VPC) endpoints for Amazon API Gateway that have been granted access.
String stageName
The name of the API Gateway stage. The name defaults to prod.
String apiGatewayId
The resource ID of the API Gateway for the proxy.
String endpointType
The type of API Gateway endpoint created.
String nlbArn
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
String nlbName
The name of the Network Load Balancer that is configured by the API Gateway proxy.
String proxyUrl
The endpoint URL of the API Gateway proxy.
String stageName
The name of the API Gateway stage. The name defaults to prod.
String vpcLinkId
The VpcLink ID of the API Gateway proxy.
ApiGatewayProxySummary apiGatewayProxy
The endpoint URL of the Amazon API Gateway proxy.
String applicationId
The unique identifier of the application.
String arn
The Amazon Resource Name (ARN) of the application.
String createdByAccountId
The Amazon Web Services account ID of the application creator.
Date createdTime
A timestamp that indicates when the application is created.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the application resource.
Date lastUpdatedTime
A timestamp that indicates when the application was last updated.
String name
The name of the application.
String ownerAccountId
The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
String proxyType
The proxy type of the proxy created within the application.
String state
The current state of the application.
Map<K,V> tags
The tags assigned to the application.
String vpcId
The ID of the virtual private cloud (VPC).
ApiGatewayProxyInput apiGatewayProxy
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String environmentIdentifier
The unique identifier of the environment.
String name
The name to use for the application.
String proxyType
The proxy type of the proxy created within the application.
Map<K,V> 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.
String vpcId
The ID of the virtual private cloud (VPC).
ApiGatewayProxyInput apiGatewayProxy
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
String applicationId
The unique identifier of the application.
String 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.
String createdByAccountId
The Amazon Web Services account ID of application creator.
Date createdTime
A timestamp that indicates when the application is created.
String environmentId
The ID of the environment in which the application is created.
Date lastUpdatedTime
A timestamp that indicates when the application was last updated.
String name
The name of the application.
String ownerAccountId
The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
String proxyType
The proxy type of the proxy created within the application.
String state
The current state of the application.
Map<K,V> 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.
String vpcId
The ID of the Amazon VPC.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String description
The description of the environment.
String name
The name of the environment.
String networkFabricType
The network fabric type of the environment.
Map<K,V> tags
The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
String arn
The Amazon Resource Name (ARN) of the environment.
Date createdTime
A timestamp that indicates when the environment is created.
String description
A description of the environment.
String environmentId
The unique identifier of the environment.
Date lastUpdatedTime
A timestamp that indicates when the environment was last updated.
String name
The name of the environment.
String networkFabricType
The network fabric type of the environment.
String ownerAccountId
The Amazon Web Services account ID of environment owner.
String state
The current state of the environment.
Map<K,V> tags
The tags assigned to the created environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
String applicationIdentifier
The ID of the application within which the route is being created.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
DefaultRouteInput defaultRoute
Configuration for the default route type.
String environmentIdentifier
The ID of the environment in which the route is created.
String routeType
The route type of the route. DEFAULT indicates that all traffic that does not match another route is
forwarded to the default route. Applications must have a default route before any other routes can be created.
URI_PATH indicates a route that is based on a URI path.
String serviceIdentifier
The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.
Map<K,V> tags
The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
UriPathRouteInput uriPathRoute
The configuration for the URI path route type.
String applicationId
The ID of the application in which the route is created.
String arn
The Amazon Resource Name (ARN) of the route. 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.
String createdByAccountId
The Amazon Web Services account ID of the route creator.
Date createdTime
A timestamp that indicates when the route is created.
Date lastUpdatedTime
A timestamp that indicates when the route was last updated.
String ownerAccountId
The Amazon Web Services account ID of the route owner.
String routeId
The unique identifier of the route.
String routeType
The route type of the route.
String serviceId
The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.
String state
The current state of the route. Activation state only allows ACTIVE or INACTIVE as user
inputs. FAILED is a route state that is system generated.
Map<K,V> tags
The tags assigned to the created route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
UriPathRouteInput uriPathRoute
Configuration for the URI path route type.
String applicationIdentifier
The ID of the application which the service is created.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String description
The description of the service.
String endpointType
The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
String environmentIdentifier
The ID of the environment in which the service is created.
LambdaEndpointInput lambdaEndpoint
The configuration for the Lambda endpoint type.
String name
The name of the service.
Map<K,V> 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..
UrlEndpointInput 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.
String vpcId
The ID of the VPC.
String applicationId
The ID of the application that the created service belongs to.
String arn
The Amazon Resource Name (ARN) of the service.
String createdByAccountId
The Amazon Web Services account ID of the service creator.
Date createdTime
A timestamp that indicates when the service is created.
String description
The description of the created service.
String endpointType
The endpoint type of the service.
String environmentId
The unique identifier of the environment.
LambdaEndpointInput lambdaEndpoint
The configuration for the Lambda endpoint type.
Date lastUpdatedTime
A timestamp that indicates when the service was last updated.
String name
The name of the service.
String ownerAccountId
The Amazon Web Services account ID of the service owner.
String serviceId
The unique identifier of the service.
String state
The current state of the service.
Map<K,V> 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..
UrlEndpointInput urlEndpoint
The configuration for the URL endpoint type.
String vpcId
The ID of the VPC.
String activationState
If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
String applicationId
The ID of the application.
String arn
The Amazon Resource Name (ARN) of the application.
String environmentId
The unique identifier of the application’s environment.
Date lastUpdatedTime
A timestamp that indicates when the environment was last updated.
String name
The name of the application.
String state
The current state of the application.
String environmentIdentifier
The ID of the environment.
String arn
The Amazon Resource Name (ARN) of the environment.
String environmentId
The unique identifier of the environment.
Date lastUpdatedTime
A timestamp that indicates when the environment was last updated.
String name
The name of the environment.
String state
The current state of the environment.
String identifier
Amazon Resource Name (ARN) of the resource associated with the policy.
String applicationId
The ID of the application that the route belongs to.
String arn
The Amazon Resource Name (ARN) of the route.
Date lastUpdatedTime
A timestamp that indicates when the route was last updated.
String routeId
The ID of the route to delete.
String serviceId
The ID of the service that the route belongs to.
String state
The current state of the route.
String applicationIdentifier
Deletes a Refactor Spaces service.
The RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services
resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.
String environmentIdentifier
The ID of the environment that the service is in.
String serviceIdentifier
The ID of the service to delete.
String applicationId
The ID of the application that the service is in.
String arn
The Amazon Resource Name (ARN) of the service.
String environmentId
The unique identifier of the environment.
Date lastUpdatedTime
A timestamp that indicates when the service was last updated.
String name
The name of the service.
String serviceId
The unique identifier of the service.
String state
The current state of the service.
String arn
The Amazon Resource Name (ARN) of the environment.
Date createdTime
A timestamp that indicates when the environment is created.
String description
A description of the environment.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the environment resource.
Date lastUpdatedTime
A timestamp that indicates when the environment was last updated.
String name
The name of the environment.
String networkFabricType
The network fabric type of the environment.
String ownerAccountId
The Amazon Web Services account ID of the environment owner.
String state
The current state of the environment.
Map<K,V> tags
The tags assigned to the environment.
String transitGatewayId
The ID of the transit gateway set up by the environment.
String accountId
The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
List<E> cidrBlocks
The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
Date createdTime
A timestamp that indicates when the VPC is first added to the environment.
String environmentId
The unique identifier of the environment.
Date lastUpdatedTime
A timestamp that indicates when the VPC was last updated by the environment.
String vpcId
The ID of the VPC.
String vpcName
The name of the VPC at the time it is added to the environment.
String accountId
The Amazon Web Services account ID of the resource owner.
Map<K,V> additionalDetails
Additional details about the error.
String code
The error code associated with the error.
String message
The message associated with the error.
String resourceIdentifier
The ID of the resource.
String resourceType
The type of resource.
ApiGatewayProxyConfig apiGatewayProxy
The endpoint URL of the API Gateway proxy.
String applicationId
The unique identifier of the application.
String arn
The Amazon Resource Name (ARN) of the application.
String createdByAccountId
The Amazon Web Services account ID of the application creator.
Date createdTime
A timestamp that indicates when the application is created.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the application resource.
Date lastUpdatedTime
A timestamp that indicates when the application was last updated.
String name
The name of the application.
String ownerAccountId
The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
String proxyType
The proxy type of the proxy created within the application.
String state
The current state of the application.
Map<K,V> 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.
String vpcId
The ID of the virtual private cloud (VPC).
String environmentIdentifier
The ID of the environment.
String arn
The Amazon Resource Name (ARN) of the environment.
Date createdTime
A timestamp that indicates when the environment is created.
String description
The description of the environment.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the environment resource.
Date lastUpdatedTime
A timestamp that indicates when the environment was last updated.
String name
The name of the environment.
String networkFabricType
The network fabric type of the environment.
String ownerAccountId
The Amazon Web Services account ID of the environment owner.
String state
The current state of the environment.
Map<K,V> tags
The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
String transitGatewayId
The ID of the transit gateway set up by the environment.
String identifier
The Amazon Resource Name (ARN) of the resource associated with the policy.
String policy
A JSON-formatted string for an Amazon Web Services resource-based policy.
String applicationId
The ID of the application that the route belongs to.
String arn
The Amazon Resource Name (ARN) of the route.
String createdByAccountId
The Amazon Web Services account ID of the route creator.
Date createdTime
The timestamp of when the route is created.
String environmentId
Unique identifier of the environment.
ErrorResponse error
Any error associated with the route resource.
Boolean includeChildPaths
Indicates whether to match all subpaths of the given source path. If this value is false, requests
must match the source path exactly before they are forwarded to this route's service.
Date lastUpdatedTime
A timestamp that indicates when the route was last updated.
List<E> methods
A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
String ownerAccountId
The Amazon Web Services account ID of the route owner.
Map<K,V> pathResourceToId
A mapping of Amazon API Gateway path resources to resource IDs.
String routeId
The unique identifier of the route.
DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.
URI_PATH: A route that is based on a URI path.
String routeType
The type of route.
String serviceId
The unique identifier of the service.
String sourcePath
The path to use to match traffic. Paths must start with / and are relative to the base of the
application.
String state
The current state of the route.
Map<K,V> tags
The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
String applicationId
The ID of the application.
String arn
The Amazon Resource Name (ARN) of the service.
String createdByAccountId
The Amazon Web Services account ID of the service creator.
Date createdTime
The timestamp of when the service is created.
String description
The description of the service.
String endpointType
The endpoint type of the service.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the service resource.
LambdaEndpointConfig lambdaEndpoint
The configuration for the Lambda endpoint type.
The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.
Date lastUpdatedTime
A timestamp that indicates when the service was last updated.
String name
The name of the service.
String ownerAccountId
The Amazon Web Services account ID of the service owner.
String serviceId
The unique identifier of the service.
String state
The current state of the service.
Map<K,V> tags
The tags assigned 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.
UrlEndpointConfig urlEndpoint
The configuration for the URL endpoint type.
The Url isthe URL of the endpoint type.
The HealthUrl is the health check URL of the endpoint type.
String vpcId
The ID of the virtual private cloud (VPC).
String arn
The Amazon Resource Name (ARN) of the Lambda endpoint.
String arn
The Amazon Resource Name (ARN) of the Lambda function or alias.
String arn
The Amazon Resource Name (ARN) of the Lambda endpoint.
String environmentIdentifier
The ID of the environment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The token for the next page of results.
String environmentIdentifier
The ID of the environment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The token for the next page of results.
String applicationIdentifier
The ID of the application.
String environmentIdentifier
The ID of the environment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The token for the next page of results.
String applicationIdentifier
The ID of the application.
String environmentIdentifier
The ID of the environment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The token for the next page of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String applicationId
The unique identifier of the application.
String arn
The Amazon Resource Name (ARN) of the route.
String createdByAccountId
The Amazon Web Services account ID of the route creator.
Date createdTime
A timestamp that indicates when the route is created.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the route resource.
Boolean includeChildPaths
Indicates whether to match all subpaths of the given source path. If this value is false, requests
must match the source path exactly before they are forwarded to this route's service.
Date lastUpdatedTime
A timestamp that indicates when the route was last updated.
List<E> methods
A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
String ownerAccountId
The Amazon Web Services account ID of the route owner.
Map<K,V> pathResourceToId
A mapping of Amazon API Gateway path resources to resource IDs.
String routeId
The unique identifier of the route.
String routeType
The route type of the route.
String serviceId
The unique identifier of the service.
String sourcePath
The path to use to match traffic. Paths must start with / and are relative to the base of the
application.
String state
The current state of the route.
Map<K,V> tags
The tags assigned to the route.
String quotaCode
Service quota requirement to identify originating quota. Reached throttling quota exception.
String resourceId
The ID of the resource.
String resourceType
The type of resource.
String serviceCode
Service quota requirement to identify originating service. Reached throttling quota exception service code.
String applicationId
The unique identifier of the application.
String arn
The Amazon Resource Name (ARN) of the service.
String createdByAccountId
The Amazon Web Services account ID of the service creator.
Date createdTime
A timestamp that indicates when the service is created.
String description
A description of the service.
String endpointType
The endpoint type of the service.
String environmentId
The unique identifier of the environment.
ErrorResponse error
Any error associated with the service resource.
LambdaEndpointSummary lambdaEndpoint
A summary of the configuration for the Lambda endpoint type.
Date lastUpdatedTime
A timestamp that indicates when the service was last updated.
String name
The name of the service.
String ownerAccountId
The Amazon Web Services account ID of the service owner.
String serviceId
The unique identifier of the service.
String state
The current state of the service.
Map<K,V> tags
The tags assigned to the service.
UrlEndpointSummary urlEndpoint
The summary of the configuration for the URL endpoint type.
String vpcId
The ID of the virtual private cloud (VPC).
String quotaCode
Service quota requirement to identify originating quota. Reached throttling quota exception.
Integer retryAfterSeconds
The number of seconds to wait before retrying.
String serviceCode
Service quota requirement to identify originating service. Reached throttling quota exception service code.
String activationState
If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.
String applicationIdentifier
The ID of the application within which the route is being updated.
String environmentIdentifier
The ID of the environment in which the route is being updated.
String routeIdentifier
The unique identifier of the route to update.
String applicationId
The ID of the application in which the route is being updated.
String arn
The Amazon Resource Name (ARN) of the route. 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.
Date lastUpdatedTime
A timestamp that indicates when the route was last updated.
String routeId
The unique identifier of the route.
String serviceId
The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.
String state
The current state of the route.
String activationState
If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
Boolean includeChildPaths
Indicates whether to match all subpaths of the given source path. If this value is false, requests
must match the source path exactly before they are forwarded to this route's service.
List<E> methods
A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
String sourcePath
The path to use to match traffic. Paths must start with / and are relative to the base of the
application.
String healthUrl
The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must
also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL
must also be a private endpoint, and the host must be the same as the URL.
String url
The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the
name must be resolvable over the public internet. If the scheme is https, the top level domain of
the host must be listed in the IANA root zone database.
String healthUrl
The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must
also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL
must also be a private endpoint, and the host must be the same as the URL.
String url
The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the
name must be resolvable over the public internet. If the scheme is https, the top level domain of
the host must be listed in the IANA root zone database.
Copyright © 2022. All rights reserved.