awsrefactorspaces

package
v1.140.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 20, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnApplication_CFN_RESOURCE_TYPE_NAME 

func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplication_IsCfnElement 

func CfnApplication_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnApplication_IsCfnResource 

func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApplication_IsConstruct 

func CfnApplication_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME 

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string

func CfnEnvironment_IsCfnElement 

func CfnEnvironment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnEnvironment_IsCfnResource 

func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnEnvironment_IsConstruct 

func CfnEnvironment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRoute_CFN_RESOURCE_TYPE_NAME 

func CfnRoute_CFN_RESOURCE_TYPE_NAME() *string

func CfnRoute_IsCfnElement 

func CfnRoute_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRoute_IsCfnResource 

func CfnRoute_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRoute_IsConstruct 

func CfnRoute_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnService_CFN_RESOURCE_TYPE_NAME 

func CfnService_CFN_RESOURCE_TYPE_NAME() *string

func CfnService_IsCfnElement 

func CfnService_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnService_IsCfnResource 

func CfnService_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnService_IsConstruct 

func CfnService_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnApplication_Override 

func NewCfnApplication_Override(c CfnApplication, scope awscdk.Construct, id *string, props *CfnApplicationProps)

Create a new `AWS::RefactorSpaces::Application`.

func NewCfnEnvironment_Override 

func NewCfnEnvironment_Override(c CfnEnvironment, scope awscdk.Construct, id *string, props *CfnEnvironmentProps)

Create a new `AWS::RefactorSpaces::Environment`.

func NewCfnRoute_Override 

func NewCfnRoute_Override(c CfnRoute, scope awscdk.Construct, id *string, props *CfnRouteProps)

Create a new `AWS::RefactorSpaces::Route`.

func NewCfnService_Override 

func NewCfnService_Override(c CfnService, scope awscdk.Construct, id *string, props *CfnServiceProps)

Create a new `AWS::RefactorSpaces::Service`.

Types

type CfnApplication 

type CfnApplication interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiGatewayProxy() interface{}
	SetApiGatewayProxy(val interface{})
	AttrApiGatewayId() *string
	AttrApplicationIdentifier() *string
	AttrArn() *string
	AttrNlbArn() *string
	AttrNlbName() *string
	AttrProxyUrl() *string
	AttrStageName() *string
	AttrVpcLinkId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EnvironmentIdentifier() *string
	SetEnvironmentIdentifier(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	ProxyType() *string
	SetProxyType(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VpcId() *string
	SetVpcId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RefactorSpaces::Application`.

Creates an AWS 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.

TODO: EXAMPLE

func NewCfnApplication 

func NewCfnApplication(scope awscdk.Construct, id *string, props *CfnApplicationProps) CfnApplication

Create a new `AWS::RefactorSpaces::Application`.

type CfnApplicationProps 

type CfnApplicationProps struct {
	// The endpoint URL of the Amazon API Gateway proxy.
	ApiGatewayProxy interface{} `json:"apiGatewayProxy" yaml:"apiGatewayProxy"`
	// The unique identifier of the environment.
	EnvironmentIdentifier *string `json:"environmentIdentifier" yaml:"environmentIdentifier"`
	// The name of the application.
	Name *string `json:"name" yaml:"name"`
	// The proxy type of the proxy created within the application.
	ProxyType *string `json:"proxyType" yaml:"proxyType"`
	// The tags assigned to the application.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The ID of the virtual private cloud (VPC).
	VpcId *string `json:"vpcId" yaml:"vpcId"`
}

Properties for defining a `CfnApplication`.

TODO: EXAMPLE

type CfnApplication_ApiGatewayProxyInputProperty 

type CfnApplication_ApiGatewayProxyInputProperty struct {
	// 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.
	EndpointType *string `json:"endpointType" yaml:"endpointType"`
	// The name of the API Gateway stage.
	//
	// The name defaults to `prod` .
	StageName *string `json:"stageName" yaml:"stageName"`
}

A wrapper object holding the Amazon API Gateway endpoint input.

TODO: EXAMPLE

type CfnEnvironment 

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrEnvironmentIdentifier() *string
	AttrTransitGatewayId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	NetworkFabricType() *string
	SetNetworkFabricType(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RefactorSpaces::Environment`.

Creates an AWS Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the *environment owner* . The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.

TODO: EXAMPLE

func NewCfnEnvironment 

func NewCfnEnvironment(scope awscdk.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment

Create a new `AWS::RefactorSpaces::Environment`.

type CfnEnvironmentProps 

type CfnEnvironmentProps struct {
	// A description of the environment.
	Description *string `json:"description" yaml:"description"`
	// The name of the environment.
	Name *string `json:"name" yaml:"name"`
	// The network fabric type of the environment.
	NetworkFabricType *string `json:"networkFabricType" yaml:"networkFabricType"`
	// The tags assigned to the environment.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEnvironment`.

TODO: EXAMPLE

type CfnRoute 

type CfnRoute interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationIdentifier() *string
	SetApplicationIdentifier(val *string)
	AttrArn() *string
	AttrPathResourceToId() *string
	AttrRouteIdentifier() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EnvironmentIdentifier() *string
	SetEnvironmentIdentifier(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	RouteType() *string
	SetRouteType(val *string)
	ServiceIdentifier() *string
	SetServiceIdentifier(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UriPathRoute() interface{}
	SetUriPathRoute(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RefactorSpaces::Route`.

Creates an AWS Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of the account creating 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` .

> In the `AWS::RefactorSpaces::Route` resource, you can only update the `SourcePath` and `Methods` properties, which reside under the `UriPathRoute` property. All other properties associated with the `AWS::RefactorSpaces::Route` cannot be updated, even though the property description might indicate otherwise.

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service.

- 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 the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. - If the service has a AWS Lambda function endpoint, then Refactor Spaces uses API Gateway ’s Lambda integration.

A health check is performed on the service when the route is created. If the health check fails, the route transitions to `FAILED` , and no traffic is sent to the service. For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so 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](https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) in the *AWS Lambda Developer Guide* . For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target groups is created and the target group health check is run. The `HealthCheckProtocol` , `HealthCheckPort` , and `HealthCheckPath` are the same protocol, port, and path specified in the URL or Health URL if used. All other settings use the default values, as described in [Health checks for your target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) . The health check is considered successful if at least one target within the target group transitions to healthy state.

TODO: EXAMPLE

func NewCfnRoute 

func NewCfnRoute(scope awscdk.Construct, id *string, props *CfnRouteProps) CfnRoute

Create a new `AWS::RefactorSpaces::Route`.

type CfnRouteProps 

type CfnRouteProps struct {
	// The unique identifier of the application.
	ApplicationIdentifier *string `json:"applicationIdentifier" yaml:"applicationIdentifier"`
	// The unique identifier of the environment.
	EnvironmentIdentifier *string `json:"environmentIdentifier" yaml:"environmentIdentifier"`
	// The unique identifier of the service.
	ServiceIdentifier *string `json:"serviceIdentifier" yaml:"serviceIdentifier"`
	// The route type of the route.
	RouteType *string `json:"routeType" yaml:"routeType"`
	// The tags assigned to the route.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The configuration for the URI path route type.
	UriPathRoute interface{} `json:"uriPathRoute" yaml:"uriPathRoute"`
}

Properties for defining a `CfnRoute`.

TODO: EXAMPLE

type CfnRoute_UriPathRouteInputProperty 

type CfnRoute_UriPathRouteInputProperty struct {
	// Indicates whether traffic is forwarded to this route’s service after the route is created.
	ActivationState *string `json:"activationState" yaml:"activationState"`
	// 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.
	IncludeChildPaths interface{} `json:"includeChildPaths" yaml:"includeChildPaths"`
	// 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.
	Methods *[]*string `json:"methods" yaml:"methods"`
	// The path to use to match traffic.
	//
	// Paths must start with `/` and are relative to the base of the application.
	SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
}

The configuration for the URI path route type.

TODO: EXAMPLE

type CfnService 

type CfnService interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationIdentifier() *string
	SetApplicationIdentifier(val *string)
	AttrArn() *string
	AttrServiceIdentifier() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EndpointType() *string
	SetEndpointType(val *string)
	EnvironmentIdentifier() *string
	SetEnvironmentIdentifier(val *string)
	LambdaEndpoint() interface{}
	SetLambdaEndpoint(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UrlEndpoint() interface{}
	SetUrlEndpoint(val interface{})
	VpcId() *string
	SetVpcId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RefactorSpaces::Service`.

Creates an AWS 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 AWS 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.

TODO: EXAMPLE

func NewCfnService 

func NewCfnService(scope awscdk.Construct, id *string, props *CfnServiceProps) CfnService

Create a new `AWS::RefactorSpaces::Service`.

type CfnServiceProps 

type CfnServiceProps struct {
	// The unique identifier of the application.
	ApplicationIdentifier *string `json:"applicationIdentifier" yaml:"applicationIdentifier"`
	// The unique identifier of the environment.
	EnvironmentIdentifier *string `json:"environmentIdentifier" yaml:"environmentIdentifier"`
	// A description of the service.
	Description *string `json:"description" yaml:"description"`
	// The endpoint type of the service.
	EndpointType *string `json:"endpointType" yaml:"endpointType"`
	// A summary of the configuration for the AWS Lambda endpoint type.
	LambdaEndpoint interface{} `json:"lambdaEndpoint" yaml:"lambdaEndpoint"`
	// The name of the service.
	Name *string `json:"name" yaml:"name"`
	// The tags assigned to the service.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The summary of the configuration for the URL endpoint type.
	UrlEndpoint interface{} `json:"urlEndpoint" yaml:"urlEndpoint"`
	// The ID of the virtual private cloud (VPC).
	VpcId *string `json:"vpcId" yaml:"vpcId"`
}

Properties for defining a `CfnService`.

TODO: EXAMPLE

type CfnService_LambdaEndpointInputProperty 

type CfnService_LambdaEndpointInputProperty struct {
	// The Amazon Resource Name (ARN) of the Lambda endpoint.
	Arn *string `json:"arn" yaml:"arn"`
}

The input for the AWS Lambda endpoint type.

TODO: EXAMPLE

type CfnService_UrlEndpointInputProperty 

type CfnService_UrlEndpointInputProperty struct {
	// The URL to route traffic to.
	//
	// The URL must be an [rfc3986-formatted URL](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc3986) . 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](https://docs.aws.amazon.com/https://www.iana.org/domains/root/db) .
	Url *string `json:"url" yaml:"url"`
	// 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.
	HealthUrl *string `json:"healthUrl" yaml:"healthUrl"`
}

The configuration for the URL endpoint type.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.