Class CfnInstance

A CloudFormation AWS::ServiceDiscovery::Instance.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnInstance
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceDiscovery
Assembly: Amazon.CDK.AWS.ServiceDiscovery.dll
Syntax (csharp)
public class CfnInstance : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnInstance
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

CloudformationResource: AWS::ServiceDiscovery::Instance

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html

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.ServiceDiscovery;

var instanceAttributes;

CfnInstance cfnInstance = new CfnInstance(this, "MyCfnInstance", new CfnInstanceProps {
    InstanceAttributes = instanceAttributes,
    ServiceId = "serviceId",

    // the properties below are optional
    InstanceId = "instanceId"
});

Synopsis

Constructors

CfnInstance(Construct, String, ICfnInstanceProps)

Create a new AWS::ServiceDiscovery::Instance.
CfnInstance(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnInstance(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
InstanceAttributes

A string map that contains the following information for the service that you specify in ServiceId :.
InstanceId

An identifier that you want to associate with the instance. Note the following:.
ServiceId

The ID of the service that you want to use for settings for the instance.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnInstance(Construct, String, ICfnInstanceProps)

Create a new AWS::ServiceDiscovery::Instance.

public CfnInstance(Construct scope, string id, ICfnInstanceProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnInstanceProps
  • resource properties.

CfnInstance(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnInstance(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnInstance(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnInstance(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

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

InstanceAttributes

A string map that contains the following information for the service that you specify in ServiceId :.

public virtual object InstanceAttributes { get; set; }
Property Value

System.Object

Remarks

    Supported attribute keys include the following:

      Note the following:

        This value is required if the service specified by ServiceId includes settings for an CNAME record.

          This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.

            This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.

              If the service includes HealthCheckConfig , the port on the endpoint that you want Route 53 to send requests to.

              This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.

              Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceattributes

              InstanceId

              An identifier that you want to associate with the instance. Note the following:.

              public virtual string InstanceId { get; set; }
              Property Value

              System.String

              Remarks
                The health check isn&apos;t deleted immediately, so it will still appear for a while if you submit a <code>ListHealthChecks</code> request, for example.

                Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceid

                ServiceId

                The ID of the service that you want to use for settings for the instance.

                public virtual string ServiceId { get; set; }
                Property Value

                System.String

                Remarks

                Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-serviceid

                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>

                Overrides

                Implements

                Constructs.IConstruct