confluentcloud.IpGroup
Explore with Pulumi AI
confluentcloud.IpGroup
provides an IP Group resource that enables creating, editing, and deleting IP Groups on Confluent Cloud.
Note: See IP Filtering on Confluent Cloud for more details about the IP Filtering feature, its prerequisites, and its limitations.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const example = new confluentcloud.IpGroup("example", {
groupName: "CorpNet",
cidrBlocks: [
"192.168.0.0/24",
"192.168.7.0/24",
],
});
import pulumi
import pulumi_confluentcloud as confluentcloud
example = confluentcloud.IpGroup("example",
group_name="CorpNet",
cidr_blocks=[
"192.168.0.0/24",
"192.168.7.0/24",
])
package main
import (
"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := confluentcloud.NewIpGroup(ctx, "example", &confluentcloud.IpGroupArgs{
GroupName: pulumi.String("CorpNet"),
CidrBlocks: pulumi.StringArray{
pulumi.String("192.168.0.0/24"),
pulumi.String("192.168.7.0/24"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var example = new ConfluentCloud.IpGroup("example", new()
{
GroupName = "CorpNet",
CidrBlocks = new[]
{
"192.168.0.0/24",
"192.168.7.0/24",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.IpGroup;
import com.pulumi.confluentcloud.IpGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new IpGroup("example", IpGroupArgs.builder()
.groupName("CorpNet")
.cidrBlocks(
"192.168.0.0/24",
"192.168.7.0/24")
.build());
}
}
resources:
example:
type: confluentcloud:IpGroup
properties:
groupName: CorpNet
cidrBlocks:
- 192.168.0.0/24
- 192.168.7.0/24
Create IpGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpGroup(name: string, args: IpGroupArgs, opts?: CustomResourceOptions);
@overload
def IpGroup(resource_name: str,
args: IpGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IpGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
cidr_blocks: Optional[Sequence[str]] = None,
group_name: Optional[str] = None)
func NewIpGroup(ctx *Context, name string, args IpGroupArgs, opts ...ResourceOption) (*IpGroup, error)
public IpGroup(string name, IpGroupArgs args, CustomResourceOptions? opts = null)
public IpGroup(String name, IpGroupArgs args)
public IpGroup(String name, IpGroupArgs args, CustomResourceOptions options)
type: confluentcloud:IpGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IpGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IpGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IpGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var ipGroupResource = new ConfluentCloud.IpGroup("ipGroupResource", new()
{
CidrBlocks = new[]
{
"string",
},
GroupName = "string",
});
example, err := confluentcloud.NewIpGroup(ctx, "ipGroupResource", &confluentcloud.IpGroupArgs{
CidrBlocks: pulumi.StringArray{
pulumi.String("string"),
},
GroupName: pulumi.String("string"),
})
var ipGroupResource = new IpGroup("ipGroupResource", IpGroupArgs.builder()
.cidrBlocks("string")
.groupName("string")
.build());
ip_group_resource = confluentcloud.IpGroup("ipGroupResource",
cidr_blocks=["string"],
group_name="string")
const ipGroupResource = new confluentcloud.IpGroup("ipGroupResource", {
cidrBlocks: ["string"],
groupName: "string",
});
type: confluentcloud:IpGroup
properties:
cidrBlocks:
- string
groupName: string
IpGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IpGroup resource accepts the following input properties:
- Cidr
Blocks List<string> - A list of CIDRs.
- Group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- Cidr
Blocks []string - A list of CIDRs.
- Group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks List<String> - A list of CIDRs.
- group
Name String - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks string[] - A list of CIDRs.
- group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr_
blocks Sequence[str] - A list of CIDRs.
- group_
name str - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks List<String> - A list of CIDRs.
- group
Name String - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
Outputs
All input properties are implicitly available as output properties. Additionally, the IpGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing IpGroup Resource
Get an existing IpGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IpGroupState, opts?: CustomResourceOptions): IpGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cidr_blocks: Optional[Sequence[str]] = None,
group_name: Optional[str] = None) -> IpGroup
func GetIpGroup(ctx *Context, name string, id IDInput, state *IpGroupState, opts ...ResourceOption) (*IpGroup, error)
public static IpGroup Get(string name, Input<string> id, IpGroupState? state, CustomResourceOptions? opts = null)
public static IpGroup get(String name, Output<String> id, IpGroupState state, CustomResourceOptions options)
resources: _: type: confluentcloud:IpGroup get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cidr
Blocks List<string> - A list of CIDRs.
- Group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- Cidr
Blocks []string - A list of CIDRs.
- Group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks List<String> - A list of CIDRs.
- group
Name String - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks string[] - A list of CIDRs.
- group
Name string - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr_
blocks Sequence[str] - A list of CIDRs.
- group_
name str - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
- cidr
Blocks List<String> - A list of CIDRs.
- group
Name String - A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters:
[
,]
,|
,&
,+
,-
,_
,/
,.
,,
.
Import
You can import an IP Group by using IP Group ID, for example:
$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/ipGroup:IpGroup example ipg-abc123
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluent
Terraform Provider.