CfnServiceProps Struct
Properties for defining a CfnService.
| Source | |
|---|---|
| Type last changed |
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',
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_refactorspaces as refactorspaces
cfn_service_props = refactorspaces.CfnServiceProps(
application_identifier="applicationIdentifier",
endpoint_type="endpointType",
environment_identifier="environmentIdentifier",
name="name",
# the properties below are optional
description="description",
lambda_endpoint=refactorspaces.CfnService.LambdaEndpointInputProperty(
arn="arn"
),
tags=[CfnTag(
key="key",
value="value"
)],
url_endpoint=refactorspaces.CfnService.UrlEndpointInputProperty(
url="url",
# the properties below are optional
health_url="healthUrl"
),
vpc_id="vpcId"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RefactorSpaces;
var cfnServiceProps = new CfnServiceProps {
ApplicationIdentifier = "applicationIdentifier",
EndpointType = "endpointType",
EnvironmentIdentifier = "environmentIdentifier",
Name = "name",
// the properties below are optional
Description = "description",
LambdaEndpoint = new LambdaEndpointInputProperty {
Arn = "arn"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UrlEndpoint = new UrlEndpointInputProperty {
Url = "url",
// the properties below are optional
HealthUrl = "healthUrl"
},
VpcId = "vpcId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServiceProps := &CfnServiceProps{
ApplicationIdentifier: jsii.String("applicationIdentifier"),
EndpointType: jsii.String("endpointType"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
LambdaEndpoint: &LambdaEndpointInputProperty{
Arn: jsii.String("arn"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UrlEndpoint: &UrlEndpointInputProperty{
Url: jsii.String("url"),
// the properties below are optional
HealthUrl: jsii.String("healthUrl"),
},
VpcId: jsii.String("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*string required #The endpoint type of the service.
environmentIdentifierstring | IEnvironmentRefenvironment_identifiertyping.Union[str, IEnvironmentRef]environmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifierinterface{} required #The unique identifier of the environment.
lambdaEndpointoptionalIResolvable | CfnService.lambda_endpointoptionaltyping.Union[IResolvable, LambdaEndpointInputProperty]lambdaEndpointoptionalIResolvableLambdaEndpointoptionalIResolvableLambdaEndpointoptionalinterface{} #A summary of the configuration for the AWS Lambda endpoint type.
The name of the service.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #The tags assigned to the service.
urlEndpointoptionalIResolvable | CfnService.url_endpointoptionaltyping.Union[IResolvable, UrlEndpointInputProperty]urlEndpointoptionalIResolvableUrlEndpointoptionalIResolvableUrlEndpointoptionalinterface{} #The summary of the configuration for the URL endpoint type.