Skip to content
v2.274.0

CfnServiceProps Struct ​

Properties for defining a CfnService.

Example ​

ts
// 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 ​

applicationIdentifierstring | IApplicationRefapplication_identifiertyping.Union[str, IApplicationRef]applicationIdentifierStringApplicationIdentifierstringApplicationIdentifierinterface{}required#
The unique identifier of the application.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the service.
endpointTypestringendpoint_typestrendpointTypeStringEndpointTypestringEndpointType*stringrequired#
The endpoint type of the service.
environmentIdentifierstring | IEnvironmentRefenvironment_identifiertyping.Union[str, IEnvironmentRef]environmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifierinterface{}required#
The unique identifier of the environment.
lambdaEndpointoptionalIResolvable | CfnService.LambdaEndpointInputPropertylambda_endpointoptionaltyping.Union[IResolvable, LambdaEndpointInputProperty]lambdaEndpointoptionalIResolvableLambdaEndpointoptionalIResolvableLambdaEndpointoptionalinterface{}#
A summary of the configuration for the AWS Lambda endpoint type.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the service.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags assigned to the service.
urlEndpointoptionalIResolvable | CfnService.UrlEndpointInputPropertyurl_endpointoptionaltyping.Union[IResolvable, UrlEndpointInputProperty]urlEndpointoptionalIResolvableUrlEndpointoptionalIResolvableUrlEndpointoptionalinterface{}#
The summary of the configuration for the URL endpoint type.
vpcIdoptionalstring | IVPCRefvpc_idoptionaltyping.Union[str, IVPCRef]vpcIdoptionalStringVpcIdoptionalstringVpcIdoptionalinterface{}#
The ID of the virtual private cloud (VPC).