Package software.amazon.awscdk.services.refactorspaces

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:22.620Z")
@Stability(Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnService.

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.*;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceProps.Builder	A builder for CfnServiceProps
static final class	CfnServiceProps.Jsii$Proxy	An implementation for CfnServiceProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceProps.Builder	builder()
String	getApplicationIdentifier()	The unique identifier of the application.
default String	getDescription()	A description of the service.
String	getEndpointType()	The endpoint type of the service.
String	getEnvironmentIdentifier()	The unique identifier of the environment.
default Object	getLambdaEndpoint()	A summary of the configuration for the AWS Lambda endpoint type.
String	getName()	The name of the service.
default List<CfnTag>	getTags()	The tags assigned to the service.
default Object	getUrlEndpoint()	The summary of the configuration for the URL endpoint type.
default String	getVpcId()	The ID of the virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationIdentifier

@Stability(Stable)
@NotNull
String getApplicationIdentifier()

The unique identifier of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-applicationidentifier

getEndpointType

@Stability(Stable)
@NotNull
String getEndpointType()

The endpoint type of the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-endpointtype

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
String getEnvironmentIdentifier()

The unique identifier of the environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-environmentidentifier

getName

@Stability(Stable)
@NotNull
String getName()

The name of the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-description

getLambdaEndpoint

@Stability(Stable)
@Nullable
default Object getLambdaEndpoint()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-lambdaendpoint

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags assigned to the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-tags

getUrlEndpoint

@Stability(Stable)
@Nullable
default Object getUrlEndpoint()

The summary of the configuration for the URL endpoint type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-urlendpoint

getVpcId

@Stability(Stable)
@Nullable
default String getVpcId()

The ID of the virtual private cloud (VPC).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-vpcid

builder

@Stability(Stable)
static CfnServiceProps.Builder builder()

Returns:

a CfnServiceProps.Builder of CfnServiceProps