Skip to content
v2.276.0

CfnWorkspaceIpGroupProps Struct ​

Properties for defining a CfnWorkspaceIpGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const cfnWorkspaceIpGroupProps: workspaces.CfnWorkspaceIpGroupProps = {
  groupName: 'groupName',

  // the properties below are optional
  groupDesc: 'groupDesc',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userRules: [{
    ipRule: 'ipRule',

    // the properties below are optional
    ruleDesc: 'ruleDesc',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspaces as workspaces

cfn_workspace_ip_group_props = workspaces.CfnWorkspaceIpGroupProps(
    group_name="groupName",

    # the properties below are optional
    group_desc="groupDesc",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_rules=[workspaces.CfnWorkspaceIpGroup.IpRuleItemProperty(
        ip_rule="ipRule",

        # the properties below are optional
        rule_desc="ruleDesc"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.workspaces.*;

CfnWorkspaceIpGroupProps cfnWorkspaceIpGroupProps = CfnWorkspaceIpGroupProps.builder()
        .groupName("groupName")

        // the properties below are optional
        .groupDesc("groupDesc")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .userRules(List.of(IpRuleItemProperty.builder()
                .ipRule("ipRule")

                // the properties below are optional
                .ruleDesc("ruleDesc")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpaces;

var cfnWorkspaceIpGroupProps = new CfnWorkspaceIpGroupProps {
    GroupName = "groupName",

    // the properties below are optional
    GroupDesc = "groupDesc",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserRules = new [] { new IpRuleItemProperty {
        IpRule = "ipRule",

        // the properties below are optional
        RuleDesc = "ruleDesc"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWorkspaceIpGroupProps := &CfnWorkspaceIpGroupProps{
	GroupName: jsii.String("groupName"),

	// the properties below are optional
	GroupDesc: jsii.String("groupDesc"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	UserRules: []interface{}{
		&IpRuleItemProperty{
			IpRule: jsii.String("ipRule"),

			// the properties below are optional
			RuleDesc: jsii.String("ruleDesc"),
		},
	},
}

Properties ​

groupDescoptionalstringgroup_descoptionalstrgroupDescoptionalStringGroupDescoptionalstringGroupDescoptional*string#
The description of the group.
groupNamestringgroup_namestrgroupNameStringGroupNamestringGroupName*stringrequired#
The name of the group.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags for the IP access control group.
userRulesoptionalIResolvable | IResolvable | CfnWorkspaceIpGroup.IpRuleItemProperty[]user_rulesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IpRuleItemProperty]]]userRulesoptionalIResolvableUserRulesoptionalIResolvableUserRulesoptionalinterface{}#
The rules for the IP access control group.