Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.928Z") @Stability(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")
         .endpointType("endpointType")
         .environmentIdentifier("environmentIdentifier")
         .name("name")
         // the properties below are optional
         .description("description")
         .lambdaEndpoint(LambdaEndpointInputProperty.builder()
                 .arn("arn")
                 .build())
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnService

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

    • CfnService

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

    • CfnService

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the service.

    • getAttrServiceIdentifier

      @Stability(Stable) @NotNull public String getAttrServiceIdentifier()
      The unique identifier of the service.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags assigned to the service.

    • getApplicationIdentifier

      @Stability(Stable) @NotNull public String getApplicationIdentifier()
      The unique identifier of the application.

    • setApplicationIdentifier

      @Stability(Stable) public void setApplicationIdentifier(@NotNull String value)
      The unique identifier of the application.

    • getEndpointType

      @Stability(Stable) @NotNull public String getEndpointType()
      The endpoint type of the service.

    • setEndpointType

      @Stability(Stable) public void setEndpointType(@NotNull String value)
      The endpoint type of the service.

    • getEnvironmentIdentifier

      @Stability(Stable) @NotNull public String getEnvironmentIdentifier()
      The unique identifier of the environment.

    • setEnvironmentIdentifier

      @Stability(Stable) public void setEnvironmentIdentifier(@NotNull String value)
      The unique identifier of the environment.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the service.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the service.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the service.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the service.

    • getLambdaEndpoint

      @Stability(Stable) @Nullable public Object getLambdaEndpoint()
      A summary of the configuration for the AWS Lambda endpoint type.

    • setLambdaEndpoint

      @Stability(Stable) public void setLambdaEndpoint(@Nullable IResolvable value)
      A summary of the configuration for the AWS Lambda endpoint type.

    • setLambdaEndpoint

      @Stability(Stable) public void setLambdaEndpoint(@Nullable CfnService.LambdaEndpointInputProperty value)
      A summary of the configuration for the AWS Lambda endpoint type.

    • getUrlEndpoint

      @Stability(Stable) @Nullable public Object getUrlEndpoint()
      The summary of the configuration for the URL endpoint type.

    • setUrlEndpoint

      @Stability(Stable) public void setUrlEndpoint(@Nullable IResolvable value)
      The summary of the configuration for the URL endpoint type.

    • setUrlEndpoint

      @Stability(Stable) public void setUrlEndpoint(@Nullable CfnService.UrlEndpointInputProperty value)
      The summary of the configuration for the URL endpoint type.

    • getVpcId

      @Stability(Stable) @Nullable public String getVpcId()
      The ID of the virtual private cloud (VPC).

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      The ID of the virtual private cloud (VPC).