Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getAddressMap

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleAddressMap = cloudflare.getAddressMap({
    accountId: "258def64c72dae45f3e4c8516e2111f2",
    addressMapId: "055817b111884e0227e1be16a0be6ee0",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_address_map = cloudflare.get_address_map(account_id="258def64c72dae45f3e4c8516e2111f2",
    address_map_id="055817b111884e0227e1be16a0be6ee0")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupAddressMap(ctx, &cloudflare.LookupAddressMapArgs{
			AccountId:    "258def64c72dae45f3e4c8516e2111f2",
			AddressMapId: pulumi.StringRef("055817b111884e0227e1be16a0be6ee0"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleAddressMap = Cloudflare.GetAddressMap.Invoke(new()
    {
        AccountId = "258def64c72dae45f3e4c8516e2111f2",
        AddressMapId = "055817b111884e0227e1be16a0be6ee0",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetAddressMapArgs;
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 exampleAddressMap = CloudflareFunctions.getAddressMap(GetAddressMapArgs.builder()
            .accountId("258def64c72dae45f3e4c8516e2111f2")
            .addressMapId("055817b111884e0227e1be16a0be6ee0")
            .build());

    }
}

variables:
  exampleAddressMap:
    fn::invoke:
      function: cloudflare:getAddressMap
      arguments:
        accountId: 258def64c72dae45f3e4c8516e2111f2
        addressMapId: 055817b111884e0227e1be16a0be6ee0

Using getAddressMap

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 getAddressMap(args: GetAddressMapArgs, opts?: InvokeOptions): Promise<GetAddressMapResult>
function getAddressMapOutput(args: GetAddressMapOutputArgs, opts?: InvokeOptions): Output<GetAddressMapResult>

def get_address_map(account_id: Optional[str] = None,
                    address_map_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAddressMapResult
def get_address_map_output(account_id: Optional[pulumi.Input[str]] = None,
                    address_map_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAddressMapResult]

func LookupAddressMap(ctx *Context, args *LookupAddressMapArgs, opts ...InvokeOption) (*LookupAddressMapResult, error)
func LookupAddressMapOutput(ctx *Context, args *LookupAddressMapOutputArgs, opts ...InvokeOption) LookupAddressMapResultOutput

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

public static class GetAddressMap 
{
    public static Task<GetAddressMapResult> InvokeAsync(GetAddressMapArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressMapResult> Invoke(GetAddressMapInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddressMapResult> getAddressMap(GetAddressMapArgs args, InvokeOptions options)
public static Output<GetAddressMapResult> getAddressMap(GetAddressMapArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getAddressMap:getAddressMap
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: Identifier of a Cloudflare account.
AddressMapId string: Identifier of an Address Map.

AccountId string: Identifier of a Cloudflare account.
AddressMapId string: Identifier of an Address Map.

accountId String: Identifier of a Cloudflare account.
addressMapId String: Identifier of an Address Map.

accountId string: Identifier of a Cloudflare account.
addressMapId string: Identifier of an Address Map.

account_id str: Identifier of a Cloudflare account.
address_map_id str: Identifier of an Address Map.

accountId String: Identifier of a Cloudflare account.
addressMapId String: Identifier of an Address Map.

getAddressMap Result

The following output properties are available:

AccountId string: Identifier of a Cloudflare account.
CanDelete bool: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
CanModifyIps bool: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
CreatedAt string
DefaultSni string: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
Description string: An optional description field which may be used to describe the types of IPs or zones on the map.
Enabled bool: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
Id string: Identifier of an Address Map.
Ips List<GetAddressMapIp>: The set of IPs on the Address Map.
Memberships List<GetAddressMapMembership>: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
ModifiedAt string
AddressMapId string: Identifier of an Address Map.

AccountId string: Identifier of a Cloudflare account.
CanDelete bool: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
CanModifyIps bool: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
CreatedAt string
DefaultSni string: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
Description string: An optional description field which may be used to describe the types of IPs or zones on the map.
Enabled bool: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
Id string: Identifier of an Address Map.
Ips []GetAddressMapIp: The set of IPs on the Address Map.
Memberships []GetAddressMapMembership: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
ModifiedAt string
AddressMapId string: Identifier of an Address Map.

accountId String: Identifier of a Cloudflare account.
canDelete Boolean: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
canModifyIps Boolean: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
createdAt String
defaultSni String: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
description String: An optional description field which may be used to describe the types of IPs or zones on the map.
enabled Boolean: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
id String: Identifier of an Address Map.
ips List<GetAddressMapIp>: The set of IPs on the Address Map.
memberships List<GetAddressMapMembership>: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
modifiedAt String
addressMapId String: Identifier of an Address Map.

accountId string: Identifier of a Cloudflare account.
canDelete boolean: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
canModifyIps boolean: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
createdAt string
defaultSni string: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
description string: An optional description field which may be used to describe the types of IPs or zones on the map.
enabled boolean: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
id string: Identifier of an Address Map.
ips GetAddressMapIp[]: The set of IPs on the Address Map.
memberships GetAddressMapMembership[]: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
modifiedAt string
addressMapId string: Identifier of an Address Map.

account_id str: Identifier of a Cloudflare account.
can_delete bool: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
can_modify_ips bool: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
created_at str
default_sni str: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
description str: An optional description field which may be used to describe the types of IPs or zones on the map.
enabled bool: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
id str: Identifier of an Address Map.
ips Sequence[GetAddressMapIp]: The set of IPs on the Address Map.
memberships Sequence[GetAddressMapMembership]: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
modified_at str
address_map_id str: Identifier of an Address Map.

accountId String: Identifier of a Cloudflare account.
canDelete Boolean: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
canModifyIps Boolean: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
createdAt String
defaultSni String: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
description String: An optional description field which may be used to describe the types of IPs or zones on the map.
enabled Boolean: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
id String: Identifier of an Address Map.
ips List<Property Map>: The set of IPs on the Address Map.
memberships List<Property Map>: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
modifiedAt String
addressMapId String: Identifier of an Address Map.

Supporting Types

GetAddressMapIp

CreatedAt string
Ip string: An IPv4 or IPv6 address.

CreatedAt string
Ip string: An IPv4 or IPv6 address.

createdAt String
ip String: An IPv4 or IPv6 address.

createdAt string
ip string: An IPv4 or IPv6 address.

created_at str
ip str: An IPv4 or IPv6 address.

createdAt String
ip String: An IPv4 or IPv6 address.

GetAddressMapMembership

CanDelete bool: Controls whether the membership can be deleted via the API or not.
CreatedAt string
Identifier string: The identifier for the membership (eg. a zone or account tag).
Kind string: The type of the membership. Available values: "zone", "account".

CanDelete bool: Controls whether the membership can be deleted via the API or not.
CreatedAt string
Identifier string: The identifier for the membership (eg. a zone or account tag).
Kind string: The type of the membership. Available values: "zone", "account".

canDelete Boolean: Controls whether the membership can be deleted via the API or not.
createdAt String
identifier String: The identifier for the membership (eg. a zone or account tag).
kind String: The type of the membership. Available values: "zone", "account".

canDelete boolean: Controls whether the membership can be deleted via the API or not.
createdAt string
identifier string: The identifier for the membership (eg. a zone or account tag).
kind string: The type of the membership. Available values: "zone", "account".

can_delete bool: Controls whether the membership can be deleted via the API or not.
created_at str
identifier str: The identifier for the membership (eg. a zone or account tag).
kind str: The type of the membership. Available values: "zone", "account".

canDelete Boolean: Controls whether the membership can be deleted via the API or not.
createdAt String
identifier String: The identifier for the membership (eg. a zone or account tag).
kind String: The type of the membership. Available values: "zone", "account".

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getAddressMap

On this page

On this page

Example Usage

Using getAddressMap

getAddressMap Result

Supporting Types

GetAddressMapIp

GetAddressMapMembership

Package Details

On this page

On this page