@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:49.844Z") public class CfnService extends CfnResource implements IInspectable
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") .environmentIdentifier("environmentIdentifier") // the properties below are optional .description("description") .endpointType("endpointType") .lambdaEndpoint(LambdaEndpointInputProperty.builder() .arn("arn") .build()) .name("name") .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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnService.Builder
A fluent builder for
CfnService . |
static interface |
CfnService.LambdaEndpointInputProperty
The input for the AWS Lambda endpoint type.
|
static interface |
CfnService.UrlEndpointInputProperty
The configuration for the URL endpoint type.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnService(Construct scope,
java.lang.String id,
CfnServiceProps props)
Create a new `AWS::RefactorSpaces::Service`.
|
protected |
CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnService(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationIdentifier()
The unique identifier of the application.
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the service.
|
java.lang.String |
getAttrServiceIdentifier()
The unique identifier of the service.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A description of the service.
|
java.lang.String |
getEndpointType()
The endpoint type of the service.
|
java.lang.String |
getEnvironmentIdentifier()
The unique identifier of the environment.
|
java.lang.Object |
getLambdaEndpoint()
A summary of the configuration for the AWS Lambda endpoint type.
|
java.lang.String |
getName()
The name of the service.
|
TagManager |
getTags()
The tags assigned to the service.
|
java.lang.Object |
getUrlEndpoint()
The summary of the configuration for the URL endpoint type.
|
java.lang.String |
getVpcId()
The ID of the virtual private cloud (VPC).
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApplicationIdentifier(java.lang.String value)
The unique identifier of the application.
|
void |
setDescription(java.lang.String value)
A description of the service.
|
void |
setEndpointType(java.lang.String value)
The endpoint type of the service.
|
void |
setEnvironmentIdentifier(java.lang.String value)
The unique identifier of the environment.
|
void |
setLambdaEndpoint(CfnService.LambdaEndpointInputProperty value)
A summary of the configuration for the AWS Lambda endpoint type.
|
void |
setLambdaEndpoint(IResolvable value)
A summary of the configuration for the AWS Lambda endpoint type.
|
void |
setName(java.lang.String value)
The name of the service.
|
void |
setUrlEndpoint(CfnService.UrlEndpointInputProperty value)
The summary of the configuration for the URL endpoint type.
|
void |
setUrlEndpoint(IResolvable value)
The summary of the configuration for the URL endpoint type.
|
void |
setVpcId(java.lang.String value)
The ID of the virtual private cloud (VPC).
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnService(Construct scope, java.lang.String id, CfnServiceProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrServiceIdentifier()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getApplicationIdentifier()
public void setApplicationIdentifier(java.lang.String value)
public java.lang.String getEnvironmentIdentifier()
public void setEnvironmentIdentifier(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getEndpointType()
public void setEndpointType(java.lang.String value)
public java.lang.Object getLambdaEndpoint()
public void setLambdaEndpoint(IResolvable value)
public void setLambdaEndpoint(CfnService.LambdaEndpointInputProperty value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getUrlEndpoint()
public void setUrlEndpoint(IResolvable value)
public void setUrlEndpoint(CfnService.UrlEndpointInputProperty value)
public java.lang.String getVpcId()
public void setVpcId(java.lang.String value)