software.amazon.awscdk.services.refactorspaces

Class CfnService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.refactorspaces.CfnService

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:49.844Z")
 @Stability(value=Stable)
public class CfnService
extends CfnResource
implements IInspectable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.refactorspaces.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .applicationIdentifier("applicationIdentifier")
         .environmentIdentifier("environmentIdentifier")
         // the properties below are optional
         .description("description")
         .endpointType("endpointType")
         .lambdaEndpoint(LambdaEndpointInputProperty.builder()
                 .arn("arn")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .urlEndpoint(UrlEndpointInputProperty.builder()
                 .url("url")
                 // the properties below are optional
                 .healthUrl("healthUrl")
                 .build())
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnService.Builder A fluent builder for CfnService.
static interface	CfnService.LambdaEndpointInputProperty The input for the AWS Lambda endpoint type.
static interface	CfnService.UrlEndpointInputProperty The configuration for the URL endpoint type.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnService(Construct scope, String id, CfnServiceProps props) Create a new `AWS::RefactorSpaces::Service`.
protected	CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnService(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationIdentifier() The unique identifier of the application.
String	getAttrArn() The Amazon Resource Name (ARN) of the service.
String	getAttrServiceIdentifier() The unique identifier of the service.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the service.
String	getEndpointType() The endpoint type of the service.
String	getEnvironmentIdentifier() The unique identifier of the environment.
Object	getLambdaEndpoint() A summary of the configuration for the AWS Lambda endpoint type.
String	getName() The name of the service.
TagManager	getTags() The tags assigned to the service.
Object	getUrlEndpoint() The summary of the configuration for the URL endpoint type.
String	getVpcId() The ID of the virtual private cloud (VPC).
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationIdentifier(String value) The unique identifier of the application.
void	setDescription(String value) A description of the service.
void	setEndpointType(String value) The endpoint type of the service.
void	setEnvironmentIdentifier(String value) The unique identifier of the environment.
void	setLambdaEndpoint(CfnService.LambdaEndpointInputProperty value) A summary of the configuration for the AWS Lambda endpoint type.
void	setLambdaEndpoint(IResolvable value) A summary of the configuration for the AWS Lambda endpoint type.
void	setName(String value) The name of the service.
void	setUrlEndpoint(CfnService.UrlEndpointInputProperty value) The summary of the configuration for the URL endpoint type.
void	setUrlEndpoint(IResolvable value) The summary of the configuration for the URL endpoint type.
void	setVpcId(String value) The ID of the virtual private cloud (VPC).

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnService

protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)

CfnService

protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnService

@Stability(value=Stable)
public CfnService(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnServiceProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the service.

getAttrServiceIdentifier

@Stability(value=Stable)
 @NotNull
public String getAttrServiceIdentifier()

The unique identifier of the service.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags assigned to the service.

getApplicationIdentifier

@Stability(value=Stable)
 @NotNull
public String getApplicationIdentifier()

The unique identifier of the application.

setApplicationIdentifier

@Stability(value=Stable)
public void setApplicationIdentifier(@NotNull
                                                              String value)

The unique identifier of the application.

getEnvironmentIdentifier

@Stability(value=Stable)
 @NotNull
public String getEnvironmentIdentifier()

The unique identifier of the environment.

setEnvironmentIdentifier

@Stability(value=Stable)
public void setEnvironmentIdentifier(@NotNull
                                                              String value)

The unique identifier of the environment.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the service.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the service.

getEndpointType

@Stability(value=Stable)
 @Nullable
public String getEndpointType()

The endpoint type of the service.

setEndpointType

@Stability(value=Stable)
public void setEndpointType(@Nullable
                                                     String value)

The endpoint type of the service.

getLambdaEndpoint

@Stability(value=Stable)
 @Nullable
public Object getLambdaEndpoint()

A summary of the configuration for the AWS Lambda endpoint type.

setLambdaEndpoint

@Stability(value=Stable)
public void setLambdaEndpoint(@Nullable
                                                       IResolvable value)

A summary of the configuration for the AWS Lambda endpoint type.

setLambdaEndpoint

@Stability(value=Stable)
public void setLambdaEndpoint(@Nullable
                                                       CfnService.LambdaEndpointInputProperty value)

A summary of the configuration for the AWS Lambda endpoint type.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the service.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the service.

getUrlEndpoint

@Stability(value=Stable)
 @Nullable
public Object getUrlEndpoint()

The summary of the configuration for the URL endpoint type.

setUrlEndpoint

@Stability(value=Stable)
public void setUrlEndpoint(@Nullable
                                                    IResolvable value)

The summary of the configuration for the URL endpoint type.

setUrlEndpoint

@Stability(value=Stable)
public void setUrlEndpoint(@Nullable
                                                    CfnService.UrlEndpointInputProperty value)

The summary of the configuration for the URL endpoint type.

getVpcId

@Stability(value=Stable)
 @Nullable
public String getVpcId()

The ID of the virtual private cloud (VPC).

setVpcId

@Stability(value=Stable)
public void setVpcId(@Nullable
                                              String value)

The ID of the virtual private cloud (VPC).