1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package migrationhubrefactorspaces
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/migrationhubrefactorspaces/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account
// owner of the service resource is always the environment owner, regardless of
// which account creates the route. Routes target a service in the application. If
// an application does not have any routes, then the first route must be created as
// a DEFAULT RouteType .
//
// When created, the default route defaults to an active state so state is not a
// required input. However, like all other state values the state of the default
// route can be updated after creation, but only when all other routes are also
// inactive. Conversely, no route can be active without the default route also
// being active.
//
// When you create a route, Refactor Spaces configures the Amazon API Gateway to
// send traffic to the target service as follows:
//
// - URL Endpoints
//
// If the service has a URL endpoint, and the endpoint resolves to a private IP
//
// address, Refactor Spaces routes traffic using the API Gateway VPC link. If a
// service endpoint resolves to a public IP address, Refactor Spaces routes traffic
// over the public internet. Services can have HTTP or HTTPS URL endpoints. For
// HTTPS URLs, publicly-signed certificates are supported. Private Certificate
// Authorities (CAs) are permitted only if the CA's domain is also publicly
// resolvable.
//
// Refactor Spaces automatically resolves the public Domain Name System (DNS)
//
// names that are set in CreateService:UrlEndpoint when you create a service.
// The DNS names resolve when the DNS time-to-live (TTL) expires, or every 60
// seconds for TTLs less than 60 seconds. This periodic DNS resolution ensures that
// the route configuration remains up-to-date.
//
// # One-time health check
//
// A one-time health check is performed on the service when either the route is
//
// updated from inactive to active, or when it is created with an active state. If
// the health check fails, the route transitions the route state to FAILED , an
// error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no
// traffic is sent to the service.
//
// For private URLs, a target group is created on the Network Load Balancer and
//
// the load balancer target group runs default target health checks. By default,
// the health check is run against the service endpoint URL. Optionally, the health
// check can be performed against a different protocol, port, and/or path using the
// [CreateService:UrlEndpoint]parameter. All other health check settings for the load balancer use the
// default values described in the [Health checks for your target groups]in the Elastic Load Balancing guide. The
// health check is considered successful if at least one target within the target
// group transitions to a healthy state.
//
// - Lambda function endpoints
//
// If the service has an Lambda function endpoint, then Refactor Spaces configures
//
// the Lambda function's resource policy to allow the application's API Gateway to
// invoke the function.
//
// The Lambda function state is checked. If the function is not active, the
//
// function configuration is updated so that Lambda resources are provisioned. If
// the Lambda state is Failed , then the route creation fails. For more
// information, see the [GetFunctionConfiguration's State response parameter]in the Lambda Developer Guide.
//
// A check is performed to determine that a Lambda function with the specified ARN
//
// exists. If it does not exist, the health check fails. For public URLs, a
// connection is opened to the public endpoint. If the URL is not reachable, the
// health check fails.
//
// # Environments without a network bridge
//
// When you create environments without a network bridge ([CreateEnvironment:NetworkFabricType] is NONE) and you use
// your own networking infrastructure, you need to configure [VPC to VPC connectivity]between your network
// and the application proxy VPC. Route creation from the application proxy to
// service endpoints will fail if your network is not configured to connect to the
// application proxy VPC. For more information, see [Create a route]in the Refactor Spaces User
// Guide.
//
// [VPC to VPC connectivity]: https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html
// [Create a route]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html
// [CreateEnvironment:NetworkFabricType]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType
//
// [CreateService:UrlEndpoint]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint
// [Health checks for your target groups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html
// [GetFunctionConfiguration's State response parameter]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State
func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error) {
if params == nil {
params = &CreateRouteInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateRoute", params, optFns, c.addOperationCreateRouteMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateRouteOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateRouteInput struct {
// The ID of the application within which the route is being created.
//
// This member is required.
ApplicationIdentifier *string
// The ID of the environment in which the route is created.
//
// This member is required.
EnvironmentIdentifier *string
// 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.
//
// This member is required.
RouteType types.RouteType
// The ID of the service in which the route is created. Traffic that matches this
// route is forwarded to this service.
//
// This member is required.
ServiceIdentifier *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// Configuration for the default route type.
DefaultRoute *types.DefaultRouteInput
// 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..
Tags map[string]string
// The configuration for the URI path route type.
UriPathRoute *types.UriPathRouteInput
noSmithyDocumentSerde
}
type CreateRouteOutput struct {
// The ID of the application in which the route is created.
ApplicationId *string
// 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.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
Arn *string
// The Amazon Web Services account ID of the route creator.
CreatedByAccountId *string
// A timestamp that indicates when the route is created.
CreatedTime *time.Time
// A timestamp that indicates when the route was last updated.
LastUpdatedTime *time.Time
// The Amazon Web Services account ID of the route owner.
OwnerAccountId *string
// The unique identifier of the route.
RouteId *string
// The route type of the route.
RouteType types.RouteType
// The ID of service in which the route is created. Traffic that matches this
// route is forwarded to this service.
ServiceId *string
// 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.
State types.RouteState
// 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.
Tags map[string]string
// Configuration for the URI path route type.
UriPathRoute *types.UriPathRouteInput
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateRouteMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateRoute{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateRoute{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateRoute"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addIdempotencyToken_opCreateRouteMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateRouteValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateRoute(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpCreateRoute struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateRoute) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateRoute) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateRouteInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateRouteInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateRouteMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateRoute{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateRoute(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateRoute",
}
}
|