1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getIpAddresses
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi

confluentcloud.getIpAddresses

Explore with Pulumi AI

confluentcloud logo
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi

    Preview

    Note: confluentcloud.getIpAddresses data source is available in Preview for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.
    Preview features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.

    confluentcloud.getIpAddresses describes IP Addresses data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const main = confluentcloud.getIpAddresses({
        filter: {
            clouds: ["AWS"],
            regions: [
                "us-east-1",
                "us-east-2",
            ],
            services: ["KAFKA"],
            addressTypes: ["EGRESS"],
        },
    });
    export const ipAddresses = main.then(main => main.ipAddresses);
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    main = confluentcloud.get_ip_addresses(filter={
        "clouds": ["AWS"],
        "regions": [
            "us-east-1",
            "us-east-2",
        ],
        "services": ["KAFKA"],
        "address_types": ["EGRESS"],
    })
    pulumi.export("ipAddresses", main.ip_addresses)
    
    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 {
    		main, err := confluentcloud.GetIpAddresses(ctx, &confluentcloud.GetIpAddressesArgs{
    			Filter: confluentcloud.GetIpAddressesFilter{
    				Clouds: []string{
    					"AWS",
    				},
    				Regions: []string{
    					"us-east-1",
    					"us-east-2",
    				},
    				Services: []string{
    					"KAFKA",
    				},
    				AddressTypes: []string{
    					"EGRESS",
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("ipAddresses", main.IpAddresses)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var main = ConfluentCloud.GetIpAddresses.Invoke(new()
        {
            Filter = new ConfluentCloud.Inputs.GetIpAddressesFilterInputArgs
            {
                Clouds = new[]
                {
                    "AWS",
                },
                Regions = new[]
                {
                    "us-east-1",
                    "us-east-2",
                },
                Services = new[]
                {
                    "KAFKA",
                },
                AddressTypes = new[]
                {
                    "EGRESS",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["ipAddresses"] = main.Apply(getIpAddressesResult => getIpAddressesResult.IpAddresses),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.ConfluentcloudFunctions;
    import com.pulumi.confluentcloud.inputs.GetIpAddressesArgs;
    import com.pulumi.confluentcloud.inputs.GetIpAddressesFilterArgs;
    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) {
            final var main = ConfluentcloudFunctions.getIpAddresses(GetIpAddressesArgs.builder()
                .filter(GetIpAddressesFilterArgs.builder()
                    .clouds("AWS")
                    .regions(                
                        "us-east-1",
                        "us-east-2")
                    .services("KAFKA")
                    .addressTypes("EGRESS")
                    .build())
                .build());
    
            ctx.export("ipAddresses", main.applyValue(getIpAddressesResult -> getIpAddressesResult.ipAddresses()));
        }
    }
    
    variables:
      main:
        fn::invoke:
          Function: confluentcloud:getIpAddresses
          Arguments:
            filter:
              clouds:
                - AWS
              regions:
                - us-east-1
                - us-east-2
              services:
                - KAFKA
              addressTypes:
                - EGRESS
    outputs:
      ipAddresses: ${main.ipAddresses}
    

    Using getIpAddresses

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpAddresses(args: GetIpAddressesArgs, opts?: InvokeOptions): Promise<GetIpAddressesResult>
    function getIpAddressesOutput(args: GetIpAddressesOutputArgs, opts?: InvokeOptions): Output<GetIpAddressesResult>
    def get_ip_addresses(filter: Optional[GetIpAddressesFilter] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIpAddressesResult
    def get_ip_addresses_output(filter: Optional[pulumi.Input[GetIpAddressesFilterArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIpAddressesResult]
    func GetIpAddresses(ctx *Context, args *GetIpAddressesArgs, opts ...InvokeOption) (*GetIpAddressesResult, error)
    func GetIpAddressesOutput(ctx *Context, args *GetIpAddressesOutputArgs, opts ...InvokeOption) GetIpAddressesResultOutput

    > Note: This function is named GetIpAddresses in the Go SDK.

    public static class GetIpAddresses 
    {
        public static Task<GetIpAddressesResult> InvokeAsync(GetIpAddressesArgs args, InvokeOptions? opts = null)
        public static Output<GetIpAddressesResult> Invoke(GetIpAddressesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpAddressesResult> getIpAddresses(GetIpAddressesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: confluentcloud:index/getIpAddresses:getIpAddresses
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getIpAddresses Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses List<Pulumi.ConfluentCloud.Outputs.GetIpAddressesIpAddress>
    (List of Object) List of schemas. Each schema object exports the following attributes:
    Filter Pulumi.ConfluentCloud.Outputs.GetIpAddressesFilter
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses []GetIpAddressesIpAddress
    (List of Object) List of schemas. Each schema object exports the following attributes:
    Filter GetIpAddressesFilter
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<GetIpAddressesIpAddress>
    (List of Object) List of schemas. Each schema object exports the following attributes:
    filter GetIpAddressesFilter
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddresses GetIpAddressesIpAddress[]
    (List of Object) List of schemas. Each schema object exports the following attributes:
    filter GetIpAddressesFilter
    id str
    The provider-assigned unique ID for this managed resource.
    ip_addresses Sequence[GetIpAddressesIpAddress]
    (List of Object) List of schemas. Each schema object exports the following attributes:
    filter GetIpAddressesFilter
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<Property Map>
    (List of Object) List of schemas. Each schema object exports the following attributes:
    filter Property Map

    Supporting Types

    GetIpAddressesFilter

    AddressTypes List<string>
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    Clouds List<string>
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    Regions List<string>
    A list of regions to filter by.
    Services List<string>
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.
    AddressTypes []string
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    Clouds []string
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    Regions []string
    A list of regions to filter by.
    Services []string
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.
    addressTypes List<String>
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    clouds List<String>
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    regions List<String>
    A list of regions to filter by.
    services List<String>
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.
    addressTypes string[]
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    clouds string[]
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    regions string[]
    A list of regions to filter by.
    services string[]
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.
    address_types Sequence[str]
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    clouds Sequence[str]
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    regions Sequence[str]
    A list of regions to filter by.
    services Sequence[str]
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.
    addressTypes List<String>
    A list of address types to filter by. Accepted values are: EGRESS, INGRESS.
    clouds List<String>
    A list of clouds to filter by. Accepted values are: AWS, AZURE, and GCP.
    regions List<String>
    A list of regions to filter by.
    services List<String>
    A list of services to filter by. Accepted values are: CONNECT, KAFKA.

    GetIpAddressesIpAddress

    AddressType string
    (Required Integer) Whether the address is used for egress or ingress.
    ApiVersion string
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    Cloud string
    (Required String) The cloud service provider in which the address exists.
    IpPrefix string
    (Required String) The IP Address range.
    Kind string
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    Region string
    (Required Integer) The region/location where the IP Address is in use.
    Services List<string>
    (Required List of Strings) The service types that will use the address.
    AddressType string
    (Required Integer) Whether the address is used for egress or ingress.
    ApiVersion string
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    Cloud string
    (Required String) The cloud service provider in which the address exists.
    IpPrefix string
    (Required String) The IP Address range.
    Kind string
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    Region string
    (Required Integer) The region/location where the IP Address is in use.
    Services []string
    (Required List of Strings) The service types that will use the address.
    addressType String
    (Required Integer) Whether the address is used for egress or ingress.
    apiVersion String
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    cloud String
    (Required String) The cloud service provider in which the address exists.
    ipPrefix String
    (Required String) The IP Address range.
    kind String
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    region String
    (Required Integer) The region/location where the IP Address is in use.
    services List<String>
    (Required List of Strings) The service types that will use the address.
    addressType string
    (Required Integer) Whether the address is used for egress or ingress.
    apiVersion string
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    cloud string
    (Required String) The cloud service provider in which the address exists.
    ipPrefix string
    (Required String) The IP Address range.
    kind string
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    region string
    (Required Integer) The region/location where the IP Address is in use.
    services string[]
    (Required List of Strings) The service types that will use the address.
    address_type str
    (Required Integer) Whether the address is used for egress or ingress.
    api_version str
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    cloud str
    (Required String) The cloud service provider in which the address exists.
    ip_prefix str
    (Required String) The IP Address range.
    kind str
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    region str
    (Required Integer) The region/location where the IP Address is in use.
    services Sequence[str]
    (Required List of Strings) The service types that will use the address.
    addressType String
    (Required Integer) Whether the address is used for egress or ingress.
    apiVersion String
    (Required String) An API Version of the schema version of the IP Address, for example, networking/v1.
    cloud String
    (Required String) The cloud service provider in which the address exists.
    ipPrefix String
    (Required String) The IP Address range.
    kind String
    (Required String) A kind of the Kafka cluster, for example, IpAddress.
    region String
    (Required Integer) The region/location where the IP Address is in use.
    services List<String>
    (Required List of Strings) The service types that will use the address.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi