aws-cdk-lib.aws_refactorspaces.CfnServiceProps

interface CfnServiceProps

LanguageType name
.NETAmazon.CDK.AWS.RefactorSpaces.CfnServiceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrefactorspaces#CfnServiceProps
Javasoftware.amazon.awscdk.services.refactorspaces.CfnServiceProps
Pythonaws_cdk.aws_refactorspaces.CfnServiceProps
TypeScript aws-cdk-lib » aws_refactorspaces » CfnServiceProps

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 { aws_refactorspaces as refactorspaces } from 'aws-cdk-lib';
const cfnServiceProps: refactorspaces.CfnServiceProps = {
  applicationIdentifier: 'applicationIdentifier',
  endpointType: 'endpointType',
  environmentIdentifier: 'environmentIdentifier',
  name: 'name',

  // the properties below are optional
  description: 'description',
  lambdaEndpoint: {
    arn: 'arn',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  urlEndpoint: {
    url: 'url',

    // the properties below are optional
    healthUrl: 'healthUrl',
  },
  vpcId: 'vpcId',
};

Properties

NameTypeDescription
applicationIdentifierstringThe unique identifier of the application.
endpointTypestringThe endpoint type of the service.
environmentIdentifierstringThe unique identifier of the environment.
namestringThe name of the service.
description?stringA description of the service.
lambdaEndpoint?IResolvable | LambdaEndpointInputPropertyA summary of the configuration for the AWS Lambda endpoint type.
tags?CfnTag[]The tags assigned to the service.
urlEndpoint?IResolvable | UrlEndpointInputPropertyThe summary of the configuration for the URL endpoint type.
vpcId?stringThe ID of the virtual private cloud (VPC).

applicationIdentifier

Type: string

The unique identifier of the application.


endpointType

Type: string

The endpoint type of the service.


environmentIdentifier

Type: string

The unique identifier of the environment.


name

Type: string

The name of the service.


description?

Type: string (optional)

A description of the service.


lambdaEndpoint?

Type: IResolvable | LambdaEndpointInputProperty (optional)

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


tags?

Type: CfnTag[] (optional)

The tags assigned to the service.


urlEndpoint?

Type: IResolvable | UrlEndpointInputProperty (optional)

The summary of the configuration for the URL endpoint type.


vpcId?

Type: string (optional)

The ID of the virtual private cloud (VPC).