Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixFqdn
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixFqdn

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    Import

    fqdn can be imported using the fqdn_tag, e.g.

     $ pulumi import aviatrix:index/aviatrixFqdn:AviatrixFqdn test fqdn_tag

    Create AviatrixFqdn Resource

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

    Constructor syntax

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

@overload
def AviatrixFqdn(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 fqdn_tag: Optional[str] = None,
                 domain_names: Optional[Sequence[AviatrixFqdnDomainNameArgs]] = None,
                 fqdn_enabled: Optional[bool] = None,
                 fqdn_mode: Optional[str] = None,
                 gw_filter_tag_lists: Optional[Sequence[AviatrixFqdnGwFilterTagListArgs]] = None,
                 manage_domain_names: Optional[bool] = None)
    func NewAviatrixFqdn(ctx *Context, name string, args AviatrixFqdnArgs, opts ...ResourceOption) (*AviatrixFqdn, error)
    public AviatrixFqdn(string name, AviatrixFqdnArgs args, CustomResourceOptions? opts = null)
    public AviatrixFqdn(String name, AviatrixFqdnArgs args)
public AviatrixFqdn(String name, AviatrixFqdnArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixFqdn
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 AviatrixFqdnArgs
    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 AviatrixFqdnArgs
    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 AviatrixFqdnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixFqdnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixFqdnArgs
    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 aviatrixFqdnResource = new Aviatrix.AviatrixFqdn("aviatrixFqdnResource", new()
{
    FqdnTag = "string",
    DomainNames = new[]
    {
        new Aviatrix.Inputs.AviatrixFqdnDomainNameArgs
        {
            Fqdn = "string",
            Port = "string",
            Proto = "string",
            Action = "string",
        },
    },
    FqdnEnabled = false,
    FqdnMode = "string",
    GwFilterTagLists = new[]
    {
        new Aviatrix.Inputs.AviatrixFqdnGwFilterTagListArgs
        {
            GwName = "string",
            SourceIpLists = new[]
            {
                "string",
            },
        },
    },
    ManageDomainNames = false,
});

    example, err := aviatrix.NewAviatrixFqdn(ctx, "aviatrixFqdnResource", &aviatrix.AviatrixFqdnArgs{
	FqdnTag: pulumi.String("string"),
	DomainNames: aviatrix.AviatrixFqdnDomainNameArray{
		&aviatrix.AviatrixFqdnDomainNameArgs{
			Fqdn:   pulumi.String("string"),
			Port:   pulumi.String("string"),
			Proto:  pulumi.String("string"),
			Action: pulumi.String("string"),
		},
	},
	FqdnEnabled: pulumi.Bool(false),
	FqdnMode:    pulumi.String("string"),
	GwFilterTagLists: aviatrix.AviatrixFqdnGwFilterTagListArray{
		&aviatrix.AviatrixFqdnGwFilterTagListArgs{
			GwName: pulumi.String("string"),
			SourceIpLists: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ManageDomainNames: pulumi.Bool(false),
})

    var aviatrixFqdnResource = new AviatrixFqdn("aviatrixFqdnResource", AviatrixFqdnArgs.builder()
    .fqdnTag("string")
    .domainNames(AviatrixFqdnDomainNameArgs.builder()
        .fqdn("string")
        .port("string")
        .proto("string")
        .action("string")
        .build())
    .fqdnEnabled(false)
    .fqdnMode("string")
    .gwFilterTagLists(AviatrixFqdnGwFilterTagListArgs.builder()
        .gwName("string")
        .sourceIpLists("string")
        .build())
    .manageDomainNames(false)
    .build());

    aviatrix_fqdn_resource = aviatrix.AviatrixFqdn("aviatrixFqdnResource",
    fqdn_tag="string",
    domain_names=[{
        "fqdn": "string",
        "port": "string",
        "proto": "string",
        "action": "string",
    }],
    fqdn_enabled=False,
    fqdn_mode="string",
    gw_filter_tag_lists=[{
        "gw_name": "string",
        "source_ip_lists": ["string"],
    }],
    manage_domain_names=False)

    const aviatrixFqdnResource = new aviatrix.AviatrixFqdn("aviatrixFqdnResource", {
    fqdnTag: "string",
    domainNames: [{
        fqdn: "string",
        port: "string",
        proto: "string",
        action: "string",
    }],
    fqdnEnabled: false,
    fqdnMode: "string",
    gwFilterTagLists: [{
        gwName: "string",
        sourceIpLists: ["string"],
    }],
    manageDomainNames: false,
});

    type: aviatrix:AviatrixFqdn
properties:
    domainNames:
        - action: string
          fqdn: string
          port: string
          proto: string
    fqdnEnabled: false
    fqdnMode: string
    fqdnTag: string
    gwFilterTagLists:
        - gwName: string
          sourceIpLists:
            - string
    manageDomainNames: false

    AviatrixFqdn 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 AviatrixFqdn resource accepts the following input properties:

    FqdnTag string
    FQDN Filter tag name.
    DomainNames List<AviatrixFqdnDomainName>
    One or more domain names in a list with details as listed below:
    FqdnEnabled bool
    FQDN Filter tag status. Valid values: true, false.
    FqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    GwFilterTagLists List<AviatrixFqdnGwFilterTagList>
    A list of gateways to attach to the specific tag.
    ManageDomainNames bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    FqdnTag string
    FQDN Filter tag name.
    DomainNames []AviatrixFqdnDomainNameArgs
    One or more domain names in a list with details as listed below:
    FqdnEnabled bool
    FQDN Filter tag status. Valid values: true, false.
    FqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    GwFilterTagLists []AviatrixFqdnGwFilterTagListArgs
    A list of gateways to attach to the specific tag.
    ManageDomainNames bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    fqdnTag String
    FQDN Filter tag name.
    domainNames List<AviatrixFqdnDomainName>
    One or more domain names in a list with details as listed below:
    fqdnEnabled Boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode String
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    gwFilterTagLists List<AviatrixFqdnGwFilterTagList>
    A list of gateways to attach to the specific tag.
    manageDomainNames Boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    fqdnTag string
    FQDN Filter tag name.
    domainNames AviatrixFqdnDomainName[]
    One or more domain names in a list with details as listed below:
    fqdnEnabled boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    gwFilterTagLists AviatrixFqdnGwFilterTagList[]
    A list of gateways to attach to the specific tag.
    manageDomainNames boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    fqdn_tag str
    FQDN Filter tag name.
    domain_names Sequence[AviatrixFqdnDomainNameArgs]
    One or more domain names in a list with details as listed below:
    fqdn_enabled bool
    FQDN Filter tag status. Valid values: true, false.
    fqdn_mode str
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    gw_filter_tag_lists Sequence[AviatrixFqdnGwFilterTagListArgs]
    A list of gateways to attach to the specific tag.
    manage_domain_names bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    fqdnTag String
    FQDN Filter tag name.
    domainNames List<Property Map>
    One or more domain names in a list with details as listed below:
    fqdnEnabled Boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode String
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    gwFilterTagLists List<Property Map>
    A list of gateways to attach to the specific tag.
    manageDomainNames Boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.

    Outputs

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

    Get an existing AviatrixFqdn 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?: AviatrixFqdnState, opts?: CustomResourceOptions): AviatrixFqdn
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_names: Optional[Sequence[AviatrixFqdnDomainNameArgs]] = None,
        fqdn_enabled: Optional[bool] = None,
        fqdn_mode: Optional[str] = None,
        fqdn_tag: Optional[str] = None,
        gw_filter_tag_lists: Optional[Sequence[AviatrixFqdnGwFilterTagListArgs]] = None,
        manage_domain_names: Optional[bool] = None) -> AviatrixFqdn
    func GetAviatrixFqdn(ctx *Context, name string, id IDInput, state *AviatrixFqdnState, opts ...ResourceOption) (*AviatrixFqdn, error)
    public static AviatrixFqdn Get(string name, Input<string> id, AviatrixFqdnState? state, CustomResourceOptions? opts = null)
    public static AviatrixFqdn get(String name, Output<String> id, AviatrixFqdnState 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:
    DomainNames List<AviatrixFqdnDomainName>
    One or more domain names in a list with details as listed below:
    FqdnEnabled bool
    FQDN Filter tag status. Valid values: true, false.
    FqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    FqdnTag string
    FQDN Filter tag name.
    GwFilterTagLists List<AviatrixFqdnGwFilterTagList>
    A list of gateways to attach to the specific tag.
    ManageDomainNames bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    DomainNames []AviatrixFqdnDomainNameArgs
    One or more domain names in a list with details as listed below:
    FqdnEnabled bool
    FQDN Filter tag status. Valid values: true, false.
    FqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    FqdnTag string
    FQDN Filter tag name.
    GwFilterTagLists []AviatrixFqdnGwFilterTagListArgs
    A list of gateways to attach to the specific tag.
    ManageDomainNames bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    domainNames List<AviatrixFqdnDomainName>
    One or more domain names in a list with details as listed below:
    fqdnEnabled Boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode String
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    fqdnTag String
    FQDN Filter tag name.
    gwFilterTagLists List<AviatrixFqdnGwFilterTagList>
    A list of gateways to attach to the specific tag.
    manageDomainNames Boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    domainNames AviatrixFqdnDomainName[]
    One or more domain names in a list with details as listed below:
    fqdnEnabled boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode string
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    fqdnTag string
    FQDN Filter tag name.
    gwFilterTagLists AviatrixFqdnGwFilterTagList[]
    A list of gateways to attach to the specific tag.
    manageDomainNames boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    domain_names Sequence[AviatrixFqdnDomainNameArgs]
    One or more domain names in a list with details as listed below:
    fqdn_enabled bool
    FQDN Filter tag status. Valid values: true, false.
    fqdn_mode str
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    fqdn_tag str
    FQDN Filter tag name.
    gw_filter_tag_lists Sequence[AviatrixFqdnGwFilterTagListArgs]
    A list of gateways to attach to the specific tag.
    manage_domain_names bool
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.
    domainNames List<Property Map>
    One or more domain names in a list with details as listed below:
    fqdnEnabled Boolean
    FQDN Filter tag status. Valid values: true, false.
    fqdnMode String
    Specify FQDN mode: whitelist or blacklist. Valid values: "white", "black".
    fqdnTag String
    FQDN Filter tag name.
    gwFilterTagLists List<Property Map>
    A list of gateways to attach to the specific tag.
    manageDomainNames Boolean
    Enable to manage domain name rules in-line. If false, domain name rules must be managed using aviatrix.AviatrixFqdnTagRule resources. Default: true. Valid values: true, false. Available in provider version R2.17+.

    Supporting Types

    AviatrixFqdnDomainName, AviatrixFqdnDomainNameArgs

    Fqdn string
    FQDN. Example: "facebook.com".
    Port string
    Port. Example "25".
    Proto string
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    Action string
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.
    Fqdn string
    FQDN. Example: "facebook.com".
    Port string
    Port. Example "25".
    Proto string
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    Action string
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.
    fqdn String
    FQDN. Example: "facebook.com".
    port String
    Port. Example "25".
    proto String
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    action String
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.
    fqdn string
    FQDN. Example: "facebook.com".
    port string
    Port. Example "25".
    proto string
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    action string
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.
    fqdn str
    FQDN. Example: "facebook.com".
    port str
    Port. Example "25".
    proto str
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    action str
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.
    fqdn String
    FQDN. Example: "facebook.com".
    port String
    Port. Example "25".
    proto String
    Protocol. Valid values: "all", "tcp", "udp", "icmp".
    action String
    What action should happen to matching requests. Possible values are: 'Base Policy', 'Allow' or 'Deny'. Defaults to 'Base Policy' if no value provided.

    • For protocol "all", port must be set to "all".
    • For protocol “icmp”, port must be set to “ping”.

    AviatrixFqdnGwFilterTagList, AviatrixFqdnGwFilterTagListArgs

    GwName string
    Name of the gateway to attach to the specific tag.
    SourceIpLists List<string>
    List of source IPs in the VPC qualified for a specific tag.
    GwName string
    Name of the gateway to attach to the specific tag.
    SourceIpLists []string
    List of source IPs in the VPC qualified for a specific tag.
    gwName String
    Name of the gateway to attach to the specific tag.
    sourceIpLists List<String>
    List of source IPs in the VPC qualified for a specific tag.
    gwName string
    Name of the gateway to attach to the specific tag.
    sourceIpLists string[]
    List of source IPs in the VPC qualified for a specific tag.
    gw_name str
    Name of the gateway to attach to the specific tag.
    source_ip_lists Sequence[str]
    List of source IPs in the VPC qualified for a specific tag.
    gwName String
    Name of the gateway to attach to the specific tag.
    sourceIpLists List<String>
    List of source IPs in the VPC qualified for a specific tag.

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
    astipkovits/pulumi-aviatrix