Class CfnTargetGroup
Creates a target group.
Inherited Members
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTargetGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTargetGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
For more information, see Target groups in the Amazon VPC Lattice User Guide .
CloudformationResource: AWS::VpcLattice::TargetGroup
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.VpcLattice;
var cfnTargetGroup = new CfnTargetGroup(this, "MyCfnTargetGroup", new CfnTargetGroupProps {
Type = "type",
// the properties below are optional
Config = new TargetGroupConfigProperty {
HealthCheck = new HealthCheckConfigProperty {
Enabled = false,
HealthCheckIntervalSeconds = 123,
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
Matcher = new MatcherProperty {
HttpCode = "httpCode"
},
Path = "path",
Port = 123,
Protocol = "protocol",
ProtocolVersion = "protocolVersion",
UnhealthyThresholdCount = 123
},
IpAddressType = "ipAddressType",
LambdaEventStructureVersion = "lambdaEventStructureVersion",
Port = 123,
Protocol = "protocol",
ProtocolVersion = "protocolVersion",
VpcIdentifier = "vpcIdentifier"
},
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Targets = new [] { new TargetProperty {
Id = "id",
// the properties below are optional
Port = 123
} }
});
Synopsis
Constructors
CfnTargetGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTargetGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnTargetGroup(Construct, String, ICfnTargetGroupProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the target group. |
AttrCreatedAt | The date and time that the target group was created, specified in ISO-8601 format. |
AttrId | The ID of the target group. |
AttrLastUpdatedAt | The date and time that the target group was last updated, specified in ISO-8601 format. |
AttrStatus | The operation's status. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Config | The target group configuration. |
Name | The name of the target group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags for the target group. |
Targets | Describes a target. |
Type | The type of target group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTargetGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTargetGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTargetGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTargetGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnTargetGroup(Construct, String, ICfnTargetGroupProps)
public CfnTargetGroup(Construct scope, string id, ICfnTargetGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTargetGroupProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the target group.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedAt
The date and time that the target group was created, specified in ISO-8601 format.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrId
The ID of the target group.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLastUpdatedAt
The date and time that the target group was last updated, specified in ISO-8601 format.
public virtual string AttrLastUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedAt
AttrStatus
The operation's status.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
You can retry the operation if the status is CREATE_FAILED
. However, if you retry it while the status is CREATE_IN_PROGRESS
, there is no change in the status.
CloudformationAttribute: Status
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
Config
The target group configuration.
public virtual object Config { get; set; }
Property Value
System.Object
Name
The name of the target group.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags for the target group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Targets
Describes a target.
public virtual object Targets { get; set; }
Property Value
System.Object
Type
The type of target group.
public virtual string Type { get; set; }
Property Value
System.String
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>