Interface ICfnGroupProps

Properties for defining a CfnGroup.

Namespace: Amazon.CDK.AWS.ResourceGroups

Assembly: Amazon.CDK.AWS.ResourceGroups.dll

Syntax (csharp)

public interface ICfnGroupProps

Syntax (vb)

Public Interface ICfnGroupProps

Remarks

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 cfnGroupProps = 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

Properties

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.

Properties

Configuration

The service configuration currently associated with the resource group and in effect for the members of the resource group.

virtual object Configuration { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-configuration

Description

The description of the resource group.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-description

Name

The name of a resource group.

string Name { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-name

ResourceQuery

The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.

virtual object ResourceQuery { get; }

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resourcequery

Resources

A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.

virtual string[] Resources { get; }

Property Value

System.String[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resources