Class CfnService
A CloudFormation AWS::RefactorSpaces::Service
.
Inherited Members
Namespace: Amazon.CDK.AWS.RefactorSpaces
Assembly: Amazon.CDK.AWS.RefactorSpaces.dll
Syntax (csharp)
public class CfnService : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnService
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::RefactorSpaces::Service
ExampleMetadata: fixture=_generated
Examples
// 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 cfnService = new CfnService(this, "MyCfnService", 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"
});
Synopsis
Constructors
CfnService(Construct, String, ICfnServiceProps) | Create a new |
CfnService(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnService(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApplicationIdentifier | The unique identifier of the application. |
AttrArn | The Amazon Resource Name (ARN) of the service. |
AttrServiceIdentifier | The unique identifier of the service. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the service. |
EndpointType | The endpoint type of the service. |
EnvironmentIdentifier | The unique identifier of the environment. |
LambdaEndpoint | A summary of the configuration for the AWS Lambda endpoint type. |
Name | The name of the service. |
Tags | The tags assigned to the service. |
UrlEndpoint | The summary of the configuration for the URL endpoint type. |
VpcId | The ID of the virtual private cloud (VPC). |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnService(Construct, String, ICfnServiceProps)
Create a new AWS::RefactorSpaces::Service
.
public CfnService(Construct scope, string id, ICfnServiceProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnServiceProps
- resource properties.
CfnService(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnService(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnService(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnService(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationIdentifier
The unique identifier of the application.
public virtual string ApplicationIdentifier { get; set; }
Property Value
System.String
Remarks
AttrArn
The Amazon Resource Name (ARN) of the service.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrServiceIdentifier
The unique identifier of the service.
public virtual string AttrServiceIdentifier { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceIdentifier
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the service.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EndpointType
The endpoint type of the service.
public virtual string EndpointType { get; set; }
Property Value
System.String
Remarks
EnvironmentIdentifier
The unique identifier of the environment.
public virtual string EnvironmentIdentifier { get; set; }
Property Value
System.String
Remarks
LambdaEndpoint
A summary of the configuration for the AWS Lambda endpoint type.
public virtual object LambdaEndpoint { get; set; }
Property Value
System.Object
Remarks
Name
The name of the service.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
The tags assigned to the service.
public virtual TagManager Tags { get; }
Property Value
Remarks
UrlEndpoint
The summary of the configuration for the URL endpoint type.
public virtual object UrlEndpoint { get; set; }
Property Value
System.Object
Remarks
VpcId
The ID of the virtual private cloud (VPC).
public virtual string VpcId { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>