Class CfnGroup
A CloudFormation AWS::Synthetics::Group
.
Inherited Members
Namespace: Amazon.CDK.AWS.Synthetics
Assembly: Amazon.CDK.AWS.Synthetics.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates or updates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
Groups are global resources. When you create a group, it is replicated across all AWS Regions, and you can add canaries from any Region to it, and view it in any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.
Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.
CloudformationResource: AWS::Synthetics::Group
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.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.Synthetics;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
Name = "name",
// the properties below are optional
ResourceArns = new [] { "resourceArns" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnGroup(Construct, String, ICfnGroupProps) | Create a new |
CfnGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrId | The Id of the group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | A name for the group. It can include any Unicode characters. |
ResourceArns | The ARNs of the canaries that you want to associate with this group. |
Tags | The list of key-value pairs that are associated with the group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGroup(Construct, String, ICfnGroupProps)
Create a new AWS::Synthetics::Group
.
public CfnGroup(Construct scope, string id, ICfnGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGroupProps
- resource properties.
CfnGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrId
The Id of the group.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Name
A name for the group. It can include any Unicode characters.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The names for all groups in your account, across all Regions, must be unique.
ResourceArns
The ARNs of the canaries that you want to associate with this group.
public virtual string[] ResourceArns { get; set; }
Property Value
System.String[]
Remarks
Tags
The list of key-value pairs that are associated with the group.
public virtual TagManager Tags { get; }
Property Value
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>