Docs Packages
  1. Packages
  2. Cloudflare
  3. API Docs
  4. FallbackDomain
Cloudflare v5.33.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.FallbackDomain

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.33.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-cloudflare

    Provides a Cloudflare Fallback Domain resource. Fallback domains are used to ignore DNS requests to a given list of domains. These DNS requests will be passed back to other DNS servers configured on existing network interfaces on the device.

    Create FallbackDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FallbackDomain(name: string, args: FallbackDomainArgs, opts?: CustomResourceOptions);
    @overload
def FallbackDomain(resource_name: str,
                   args: FallbackDomainArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def FallbackDomain(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   account_id: Optional[str] = None,
                   domains: Optional[Sequence[FallbackDomainDomainArgs]] = None,
                   policy_id: Optional[str] = None)
    func NewFallbackDomain(ctx *Context, name string, args FallbackDomainArgs, opts ...ResourceOption) (*FallbackDomain, error)
    public FallbackDomain(string name, FallbackDomainArgs args, CustomResourceOptions? opts = null)
    public FallbackDomain(String name, FallbackDomainArgs args)
public FallbackDomain(String name, FallbackDomainArgs args, CustomResourceOptions options)

    type: cloudflare:FallbackDomain
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 FallbackDomainArgs
    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 FallbackDomainArgs
    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 FallbackDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FallbackDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FallbackDomainArgs
    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 fallbackDomainResource = new Cloudflare.FallbackDomain("fallbackDomainResource", new()
{
    AccountId = "string",
    Domains = new[]
    {
        new Cloudflare.Inputs.FallbackDomainDomainArgs
        {
            Description = "string",
            DnsServers = new[]
            {
                "string",
            },
            Suffix = "string",
        },
    },
    PolicyId = "string",
});

    example, err := cloudflare.NewFallbackDomain(ctx, "fallbackDomainResource", &cloudflare.FallbackDomainArgs{
	AccountId: pulumi.String("string"),
	Domains: cloudflare.FallbackDomainDomainArray{
		&cloudflare.FallbackDomainDomainArgs{
			Description: pulumi.String("string"),
			DnsServers: pulumi.StringArray{
				pulumi.String("string"),
			},
			Suffix: pulumi.String("string"),
		},
	},
	PolicyId: pulumi.String("string"),
})

    var fallbackDomainResource = new FallbackDomain("fallbackDomainResource", FallbackDomainArgs.builder()
    .accountId("string")
    .domains(FallbackDomainDomainArgs.builder()
        .description("string")
        .dnsServers("string")
        .suffix("string")
        .build())
    .policyId("string")
    .build());

    fallback_domain_resource = cloudflare.FallbackDomain("fallbackDomainResource",
    account_id="string",
    domains=[cloudflare.FallbackDomainDomainArgs(
        description="string",
        dns_servers=["string"],
        suffix="string",
    )],
    policy_id="string")

    const fallbackDomainResource = new cloudflare.FallbackDomain("fallbackDomainResource", {
    accountId: "string",
    domains: [{
        description: "string",
        dnsServers: ["string"],
        suffix: "string",
    }],
    policyId: "string",
});

    type: cloudflare:FallbackDomain
properties:
    accountId: string
    domains:
        - description: string
          dnsServers:
            - string
          suffix: string
    policyId: string

    FallbackDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FallbackDomain resource accepts the following input properties:

    AccountId string
    The account identifier to target for the resource.
    Domains List<FallbackDomainDomain>
    PolicyId string
    The settings policy for which to configure this fallback domain policy.
    AccountId string
    The account identifier to target for the resource.
    Domains []FallbackDomainDomainArgs
    PolicyId string
    The settings policy for which to configure this fallback domain policy.
    accountId String
    The account identifier to target for the resource.
    domains List<FallbackDomainDomain>
    policyId String
    The settings policy for which to configure this fallback domain policy.
    accountId string
    The account identifier to target for the resource.
    domains FallbackDomainDomain[]
    policyId string
    The settings policy for which to configure this fallback domain policy.
    account_id str
    The account identifier to target for the resource.
    domains Sequence[FallbackDomainDomainArgs]
    policy_id str
    The settings policy for which to configure this fallback domain policy.
    accountId String
    The account identifier to target for the resource.
    domains List<Property Map>
    policyId String
    The settings policy for which to configure this fallback domain policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FallbackDomain 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 FallbackDomain Resource

    Get an existing FallbackDomain 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?: FallbackDomainState, opts?: CustomResourceOptions): FallbackDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        domains: Optional[Sequence[FallbackDomainDomainArgs]] = None,
        policy_id: Optional[str] = None) -> FallbackDomain
    func GetFallbackDomain(ctx *Context, name string, id IDInput, state *FallbackDomainState, opts ...ResourceOption) (*FallbackDomain, error)
    public static FallbackDomain Get(string name, Input<string> id, FallbackDomainState? state, CustomResourceOptions? opts = null)
    public static FallbackDomain get(String name, Output<String> id, FallbackDomainState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AccountId string
    The account identifier to target for the resource.
    Domains List<FallbackDomainDomain>
    PolicyId string
    The settings policy for which to configure this fallback domain policy.
    AccountId string
    The account identifier to target for the resource.
    Domains []FallbackDomainDomainArgs
    PolicyId string
    The settings policy for which to configure this fallback domain policy.
    accountId String
    The account identifier to target for the resource.
    domains List<FallbackDomainDomain>
    policyId String
    The settings policy for which to configure this fallback domain policy.
    accountId string
    The account identifier to target for the resource.
    domains FallbackDomainDomain[]
    policyId string
    The settings policy for which to configure this fallback domain policy.
    account_id str
    The account identifier to target for the resource.
    domains Sequence[FallbackDomainDomainArgs]
    policy_id str
    The settings policy for which to configure this fallback domain policy.
    accountId String
    The account identifier to target for the resource.
    domains List<Property Map>
    policyId String
    The settings policy for which to configure this fallback domain policy.

    Supporting Types

    FallbackDomainDomain, FallbackDomainDomainArgs

    Description string
    A description of the fallback domain, displayed in the client UI.
    DnsServers List<string>
    A list of IP addresses to handle domain resolution.
    Suffix string
    The domain suffix to match when resolving locally.
    Description string
    A description of the fallback domain, displayed in the client UI.
    DnsServers []string
    A list of IP addresses to handle domain resolution.
    Suffix string
    The domain suffix to match when resolving locally.
    description String
    A description of the fallback domain, displayed in the client UI.
    dnsServers List<String>
    A list of IP addresses to handle domain resolution.
    suffix String
    The domain suffix to match when resolving locally.
    description string
    A description of the fallback domain, displayed in the client UI.
    dnsServers string[]
    A list of IP addresses to handle domain resolution.
    suffix string
    The domain suffix to match when resolving locally.
    description str
    A description of the fallback domain, displayed in the client UI.
    dns_servers Sequence[str]
    A list of IP addresses to handle domain resolution.
    suffix str
    The domain suffix to match when resolving locally.
    description String
    A description of the fallback domain, displayed in the client UI.
    dnsServers List<String>
    A list of IP addresses to handle domain resolution.
    suffix String
    The domain suffix to match when resolving locally.

    Import

    Fallback Domains for default device policies must use “default” as the policy ID.

    $ pulumi import cloudflare:index/fallbackDomain:FallbackDomain example <account_id>/<policy_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.33.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-cloudflare