Class CfnGroup
Creates a resource group with the specified name and description.
Inherited Members
Namespace: Amazon.CDK.AWS.ResourceGroups
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in AWS Resource Groups in the AWS Resource Groups User Guide . For more information about service-linked groups and service configurations, see Service configurations for Resource Groups .
Minimum permissions
To run this command, you must have the following permissions:
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html
CloudformationResource: AWS::ResourceGroups::Group
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.ResourceGroups;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
Name = "name",
// the properties below are optional
Configuration = new [] { new ConfigurationItemProperty {
Parameters = new [] { new ConfigurationParameterProperty {
Name = "name",
Values = new [] { "values" }
} },
Type = "type"
} },
Description = "description",
ResourceQuery = new ResourceQueryProperty {
Query = new QueryProperty {
ResourceTypeFilters = new [] { "resourceTypeFilters" },
StackIdentifier = "stackIdentifier",
TagFilters = new [] { new TagFilterProperty {
Key = "key",
Values = new [] { "values" }
} }
},
Type = "type"
},
Resources = new [] { "resources" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnGroup(Construct, String, ICfnGroupProps) |
Properties
AttrArn | The ARN of the new resource group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Configuration | The service configuration currently associated with the resource group and in effect for the members of the resource group. |
Description | The description of the resource group. |
Name | The name of a resource group. |
ResourceQuery | The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. |
Resources | A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tag key and value pairs that are attached to the resource group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnGroup(Construct, String, ICfnGroupProps)
public CfnGroup(Construct scope, string id, ICfnGroupProps 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 ICfnGroupProps
Resource properties.
Properties
AttrArn
The ARN of the new resource group.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
Configuration
The service configuration currently associated with the resource group and in effect for the members of the resource group.
public virtual object Configuration { get; set; }
Property Value
System.Object
Description
The description of the resource group.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of a resource group.
public virtual string Name { get; set; }
Property Value
System.String
ResourceQuery
The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
public virtual object ResourceQuery { get; set; }
Property Value
System.Object
Resources
A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.
public virtual string[] Resources { 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 tag key and value pairs that are attached to the resource group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>