awsresourcegroups

Documentation

Index

• func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string
• func CfnGroup_IsCfnElement(x interface{}) *bool
• func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnGroup_IsConstruct(x interface{}) *bool
• func NewCfnGroup_Override(c CfnGroup, scope awscdk.Construct, id *string, props *CfnGroupProps)
• type CfnGroup
  • func NewCfnGroup(scope awscdk.Construct, id *string, props *CfnGroupProps) CfnGroup
• type CfnGroupProps
• type CfnGroup_ConfigurationItemProperty
• type CfnGroup_ConfigurationParameterProperty
• type CfnGroup_QueryProperty
• type CfnGroup_ResourceQueryProperty
• type CfnGroup_TagFilterProperty

Functions

func CfnGroup_CFN_RESOURCE_TYPE_NAME

func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnGroup_IsCfnElement

func CfnGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnGroup_IsCfnResource

func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGroup_IsConstruct

func CfnGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnGroup_Override

func NewCfnGroup_Override(c CfnGroup, scope awscdk.Construct, id *string, props *CfnGroupProps)

Create a new `AWS::ResourceGroups::Group`.

Types

type CfnGroup

type CfnGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Configuration() interface{}
	SetConfiguration(val interface{})
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	ResourceQuery() interface{}
	SetResourceQuery(val interface{})
	Resources() *[]*string
	SetResources(val *[]*string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ResourceGroups::Group`.

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](https://docs.aws.amazon.com//ARG/latest/userguide/getting_started-query.html) in the *AWS Resource Groups User Guide* . For more information about service-linked groups and service configurations, see [Service configurations for Resource Groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) .

*Minimum permissions*

To run this command, you must have the following permissions:

- `resource-groups:CreateGroup`

TODO: EXAMPLE

func NewCfnGroup

func NewCfnGroup(scope awscdk.Construct, id *string, props *CfnGroupProps) CfnGroup

Create a new `AWS::ResourceGroups::Group`.

type CfnGroupProps

type CfnGroupProps struct {
	// The name of a resource group.
	//
	// 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.
	Name *string `json:"name" yaml:"name"`
	// The service configuration currently associated with the resource group and in effect for the members of the resource group.
	//
	// 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](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .
	//
	// > You can include either a `Configuration` or a `ResourceQuery` , but not both.
	Configuration interface{} `json:"configuration" yaml:"configuration"`
	// The description of the resource group.
	Description *string `json:"description" yaml:"description"`
	// The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
	//
	// For more information about queries and how to construct them, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) in the *AWS Resource Groups User Guide*
	//
	// > - You can include either a `ResourceQuery` or a `Configuration` , but not both.
	// > - You can specify the group's membership either by using a `ResourceQuery` or by using a list of `Resources` , but not both.
	ResourceQuery interface{} `json:"resourceQuery" yaml:"resourceQuery"`
	// A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.
	//
	// > - You can specify the group membership either by using a list of `Resources` or by using a `ResourceQuery` , but not both.
	// > - You can include a `Resources` property only if you also specify a `Configuration` property.
	Resources *[]*string `json:"resources" yaml:"resources"`
	// The tag key and value pairs that are attached to the resource group.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnGroup`.

TODO: EXAMPLE

type CfnGroup_ConfigurationItemProperty

type CfnGroup_ConfigurationItemProperty struct {
	// A collection of parameters for this configuration item.
	//
	// For the list of parameters that you can use with each configuration item `Type` , see [Supported resource types and parameters](https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// Specifies the type of configuration item.
	//
	// Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see [Supported resource types and parameters](https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
	Type *string `json:"type" yaml:"type"`
}

One of the items in the service configuration assigned to a resource group.

A service configuration can consist of one or more items. For details service configurations and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .

TODO: EXAMPLE

type CfnGroup_ConfigurationParameterProperty

type CfnGroup_ConfigurationParameterProperty struct {
	// The name of the group configuration parameter.
	//
	// For the list of parameters that you can use with each configuration item type, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
	Name *string `json:"name" yaml:"name"`
	// The value or values to be used for the specified parameter.
	//
	// For the list of values you can use with each parameter, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) .
	Values *[]*string `json:"values" yaml:"values"`
}

One parameter for a group configuration item.

For details about service configurations and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .

TODO: EXAMPLE

type CfnGroup_QueryProperty

type CfnGroup_QueryProperty struct {
	// Specifies limits to the types of resources that can be included in the resource group.
	//
	// For example, if `ResourceTypeFilters` is `["AWS::EC2::Instance", "AWS::DynamoDB::Table"]` , only EC2 instances or DynamoDB tables can be members of this resource group. The default value is `["AWS::AllSupported"]` .
	ResourceTypeFilters *[]*string `json:"resourceTypeFilters" yaml:"resourceTypeFilters"`
	// Specifies the ARN of a CloudFormation stack.
	//
	// All supported resources of the CloudFormation stack are members of the resource group. If you don't specify an ARN, this parameter defaults to the current stack that you are defining, which means that all the resources of the current stack are grouped.
	//
	// You can specify a value for `StackIdentifier` only when the `ResourceQuery.Type` property is `CLOUDFORMATION_STACK_1_0.`
	StackIdentifier *string `json:"stackIdentifier" yaml:"stackIdentifier"`
	// A list of key-value pair objects that limit which resources can be members of the resource group.
	//
	// This property is required when the `ResourceQuery.Type` property is `TAG_FILTERS_1_0` .
	//
	// A resource must have a tag that matches every filter that is provided in the `TagFilters` list.
	TagFilters interface{} `json:"tagFilters" yaml:"tagFilters"`
}

Specifies details within a `ResourceQuery` structure that determines the membership of the resource group.

The contents required in the `Query` structure are determined by the `Type` property of the containing `ResourceQuery` structure.

TODO: EXAMPLE

type CfnGroup_ResourceQueryProperty

type CfnGroup_ResourceQueryProperty struct {
	// The query that defines the membership of the group.
	//
	// This is a structure with properties that depend on the `Type` .
	//
	// The `Query` structure must be included in the following scenarios:
	//
	// - When the `Type` is `TAG_FILTERS_1_0` , you must specify a `Query` structure that contains a `TagFilters` list of tags. Resources with tags that match those in the `TagFilter` list become members of the resource group.
	// - When the `Type` is `CLOUDFORMATION_STACK_1_0` then this field is required only when you must specify a CloudFormation stack other than the one you are defining. To do this, the `Query` structure must contain the `StackIdentifier` property. If you don't specify either a `Query` structure or a `StackIdentifier` within that `Query` , then it defaults to the CloudFormation stack that you're currently constructing.
	Query interface{} `json:"query" yaml:"query"`
	// Specifies the type of resource query that determines this group's membership. There are two valid query types:.
	//
	// - `TAG_FILTERS_1_0` indicates that the group is a tag-based group. To complete the group membership, you must include the `TagFilters` property to specify the tag filters to use in the query.
	// - `CLOUDFORMATION_STACK_1_0` , the default, indicates that the group is a CloudFormation stack-based group. Group membership is based on the CloudFormation stack. You must specify the `StackIdentifier` property in the query to define which stack to associate the group with, or leave it empty to default to the stack where the group is defined.
	Type *string `json:"type" yaml:"type"`
}

The query used to dynamically define the members of a group.

For more information about how to construct a query, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) .

TODO: EXAMPLE

type CfnGroup_TagFilterProperty

type CfnGroup_TagFilterProperty struct {
	// A string that defines a tag key.
	//
	// Only resources in the account that are tagged with a specified tag key are members of the tag-based resource group.
	//
	// This field is required when the `ResourceQuery` structure's `Type` property is `TAG_FILTERS_1_0` . You must specify at least one tag key.
	Key *string `json:"key" yaml:"key"`
	// A list of tag values that can be included in the tag-based resource group.
	//
	// This is optional. If you don't specify a value or values for a key, then an AWS resource with any value for that key is a member.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies a single tag key and optional values that you can use to specify membership in a tag-based group.

An AWS resource that doesn't have a matching tag key and value is rejected as a member of the group.

A `TagFilter` object includes two properties: `Key` (a string) and `Values` (a list of strings). Only resources in the account that are tagged with a matching key-value pair are members of the group. The `Values` property of `TagFilter` is optional, but specifying it narrows the query results.

As an example, suppose the `TagFilters` string is `[{"Key": "Stage", "Values": ["Test", "Beta"]}, {"Key": "Storage"}]` . In this case, only resources with all of the following tags are members of the group:

- `Stage` tag key with a value of either `Test` or `Beta` - `Storage` tag key with any value

TODO: EXAMPLE