Class CfnGroup
A CloudFormation AWS::ResourceGroups::Group
.
Inherited Members
Namespace: Amazon.CDK.AWS.ResourceGroups
Assembly: Amazon.CDK.AWS.ResourceGroups.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a resource group with the specified name and description. 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:
CloudformationResource: AWS::ResourceGroups::Group
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-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.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(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
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 | 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(Construct, String, ICfnGroupProps)
Create a new AWS::ResourceGroups::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
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
Remarks
A Configuration
consists of one or more ConfigurationItem
entries. For information about service configurations for resource groups and how to construct them, see Service configurations for resource groups in the AWS Resource Groups User Guide .
You can include either a Configuration
or a ResourceQuery
, but not both.
Description
The description of the resource group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of a resource group.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name must be unique within the AWS Region in which you create the resource. To create multiple resource groups based on the same CloudFormation stack, you must generate unique names for each.
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
Remarks
For more information about queries and how to construct them, see Build queries and groups in AWS Resource Groups in the AWS Resource Groups User Guide
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[]
Remarks
Tags
The tag key and value pairs that are attached to the resource 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>