Docs Packages
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixGatewaySnat
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixGatewaySnat

Explore with Pulumi AI

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

    Import

    gateway_snat can be imported using the gw_name, e.g.

     $ pulumi import aviatrix:index/aviatrixGatewaySnat:AviatrixGatewaySnat test gw_name

    Create AviatrixGatewaySnat Resource

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

    Constructor syntax

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

@overload
def AviatrixGatewaySnat(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        gw_name: Optional[str] = None,
                        snat_mode: Optional[str] = None,
                        snat_policies: Optional[Sequence[AviatrixGatewaySnatSnatPolicyArgs]] = None,
                        sync_to_ha: Optional[bool] = None)
    func NewAviatrixGatewaySnat(ctx *Context, name string, args AviatrixGatewaySnatArgs, opts ...ResourceOption) (*AviatrixGatewaySnat, error)
    public AviatrixGatewaySnat(string name, AviatrixGatewaySnatArgs args, CustomResourceOptions? opts = null)
    public AviatrixGatewaySnat(String name, AviatrixGatewaySnatArgs args)
public AviatrixGatewaySnat(String name, AviatrixGatewaySnatArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixGatewaySnat
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 AviatrixGatewaySnatArgs
    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 AviatrixGatewaySnatArgs
    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 AviatrixGatewaySnatArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixGatewaySnatArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixGatewaySnatArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var aviatrixGatewaySnatResource = new Aviatrix.AviatrixGatewaySnat("aviatrixGatewaySnatResource", new()
{
    GwName = "string",
    SnatMode = "string",
    SnatPolicies = new[]
    {
        new Aviatrix.Inputs.AviatrixGatewaySnatSnatPolicyArgs
        {
            ApplyRouteEntry = false,
            Connection = "string",
            DstCidr = "string",
            DstPort = "string",
            ExcludeRtb = "string",
            Interface = "string",
            Mark = "string",
            Protocol = "string",
            SnatIps = "string",
            SnatPort = "string",
            SrcCidr = "string",
            SrcPort = "string",
        },
    },
    SyncToHa = false,
});

    example, err := aviatrix.NewAviatrixGatewaySnat(ctx, "aviatrixGatewaySnatResource", &aviatrix.AviatrixGatewaySnatArgs{
	GwName:   pulumi.String("string"),
	SnatMode: pulumi.String("string"),
	SnatPolicies: aviatrix.AviatrixGatewaySnatSnatPolicyArray{
		&aviatrix.AviatrixGatewaySnatSnatPolicyArgs{
			ApplyRouteEntry: pulumi.Bool(false),
			Connection:      pulumi.String("string"),
			DstCidr:         pulumi.String("string"),
			DstPort:         pulumi.String("string"),
			ExcludeRtb:      pulumi.String("string"),
			Interface:       pulumi.String("string"),
			Mark:            pulumi.String("string"),
			Protocol:        pulumi.String("string"),
			SnatIps:         pulumi.String("string"),
			SnatPort:        pulumi.String("string"),
			SrcCidr:         pulumi.String("string"),
			SrcPort:         pulumi.String("string"),
		},
	},
	SyncToHa: pulumi.Bool(false),
})

    var aviatrixGatewaySnatResource = new AviatrixGatewaySnat("aviatrixGatewaySnatResource", AviatrixGatewaySnatArgs.builder()        
    .gwName("string")
    .snatMode("string")
    .snatPolicies(AviatrixGatewaySnatSnatPolicyArgs.builder()
        .applyRouteEntry(false)
        .connection("string")
        .dstCidr("string")
        .dstPort("string")
        .excludeRtb("string")
        .interface_("string")
        .mark("string")
        .protocol("string")
        .snatIps("string")
        .snatPort("string")
        .srcCidr("string")
        .srcPort("string")
        .build())
    .syncToHa(false)
    .build());

    aviatrix_gateway_snat_resource = aviatrix.AviatrixGatewaySnat("aviatrixGatewaySnatResource",
    gw_name="string",
    snat_mode="string",
    snat_policies=[aviatrix.AviatrixGatewaySnatSnatPolicyArgs(
        apply_route_entry=False,
        connection="string",
        dst_cidr="string",
        dst_port="string",
        exclude_rtb="string",
        interface="string",
        mark="string",
        protocol="string",
        snat_ips="string",
        snat_port="string",
        src_cidr="string",
        src_port="string",
    )],
    sync_to_ha=False)

    const aviatrixGatewaySnatResource = new aviatrix.AviatrixGatewaySnat("aviatrixGatewaySnatResource", {
    gwName: "string",
    snatMode: "string",
    snatPolicies: [{
        applyRouteEntry: false,
        connection: "string",
        dstCidr: "string",
        dstPort: "string",
        excludeRtb: "string",
        "interface": "string",
        mark: "string",
        protocol: "string",
        snatIps: "string",
        snatPort: "string",
        srcCidr: "string",
        srcPort: "string",
    }],
    syncToHa: false,
});

    type: aviatrix:AviatrixGatewaySnat
properties:
    gwName: string
    snatMode: string
    snatPolicies:
        - applyRouteEntry: false
          connection: string
          dstCidr: string
          dstPort: string
          excludeRtb: string
          interface: string
          mark: string
          protocol: string
          snatIps: string
          snatPort: string
          srcCidr: string
          srcPort: string
    syncToHa: false

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

    GwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    SnatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    SnatPolicies List<AviatrixGatewaySnatSnatPolicy>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    SyncToHa bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    GwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    SnatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    SnatPolicies []AviatrixGatewaySnatSnatPolicyArgs
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    SyncToHa bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    gwName String
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    snatMode String
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies List<AviatrixGatewaySnatSnatPolicy>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa Boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    gwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    snatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies AviatrixGatewaySnatSnatPolicy[]
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    gw_name str
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    snat_mode str
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snat_policies Sequence[AviatrixGatewaySnatSnatPolicyArgs]
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    sync_to_ha bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    gwName String
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    snatMode String
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies List<Property Map>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa Boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AviatrixGatewaySnat resource produces the following output properties:

    ConnectionPolicies List<AviatrixGatewaySnatConnectionPolicy>
    Computed attribute to store the previous connection policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfacePolicies List<AviatrixGatewaySnatInterfacePolicy>
    Computed attribute to store the previous interface policy.
    ConnectionPolicies []AviatrixGatewaySnatConnectionPolicy
    Computed attribute to store the previous connection policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfacePolicies []AviatrixGatewaySnatInterfacePolicy
    Computed attribute to store the previous interface policy.
    connectionPolicies List<AviatrixGatewaySnatConnectionPolicy>
    Computed attribute to store the previous connection policy.
    id String
    The provider-assigned unique ID for this managed resource.
    interfacePolicies List<AviatrixGatewaySnatInterfacePolicy>
    Computed attribute to store the previous interface policy.
    connectionPolicies AviatrixGatewaySnatConnectionPolicy[]
    Computed attribute to store the previous connection policy.
    id string
    The provider-assigned unique ID for this managed resource.
    interfacePolicies AviatrixGatewaySnatInterfacePolicy[]
    Computed attribute to store the previous interface policy.
    connection_policies Sequence[AviatrixGatewaySnatConnectionPolicy]
    Computed attribute to store the previous connection policy.
    id str
    The provider-assigned unique ID for this managed resource.
    interface_policies Sequence[AviatrixGatewaySnatInterfacePolicy]
    Computed attribute to store the previous interface policy.
    connectionPolicies List<Property Map>
    Computed attribute to store the previous connection policy.
    id String
    The provider-assigned unique ID for this managed resource.
    interfacePolicies List<Property Map>
    Computed attribute to store the previous interface policy.

    Look up Existing AviatrixGatewaySnat Resource

    Get an existing AviatrixGatewaySnat 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?: AviatrixGatewaySnatState, opts?: CustomResourceOptions): AviatrixGatewaySnat
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_policies: Optional[Sequence[AviatrixGatewaySnatConnectionPolicyArgs]] = None,
        gw_name: Optional[str] = None,
        interface_policies: Optional[Sequence[AviatrixGatewaySnatInterfacePolicyArgs]] = None,
        snat_mode: Optional[str] = None,
        snat_policies: Optional[Sequence[AviatrixGatewaySnatSnatPolicyArgs]] = None,
        sync_to_ha: Optional[bool] = None) -> AviatrixGatewaySnat
    func GetAviatrixGatewaySnat(ctx *Context, name string, id IDInput, state *AviatrixGatewaySnatState, opts ...ResourceOption) (*AviatrixGatewaySnat, error)
    public static AviatrixGatewaySnat Get(string name, Input<string> id, AviatrixGatewaySnatState? state, CustomResourceOptions? opts = null)
    public static AviatrixGatewaySnat get(String name, Output<String> id, AviatrixGatewaySnatState 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:
    ConnectionPolicies List<AviatrixGatewaySnatConnectionPolicy>
    Computed attribute to store the previous connection policy.
    GwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    InterfacePolicies List<AviatrixGatewaySnatInterfacePolicy>
    Computed attribute to store the previous interface policy.
    SnatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    SnatPolicies List<AviatrixGatewaySnatSnatPolicy>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    SyncToHa bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    ConnectionPolicies []AviatrixGatewaySnatConnectionPolicyArgs
    Computed attribute to store the previous connection policy.
    GwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    InterfacePolicies []AviatrixGatewaySnatInterfacePolicyArgs
    Computed attribute to store the previous interface policy.
    SnatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    SnatPolicies []AviatrixGatewaySnatSnatPolicyArgs
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    SyncToHa bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    connectionPolicies List<AviatrixGatewaySnatConnectionPolicy>
    Computed attribute to store the previous connection policy.
    gwName String
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    interfacePolicies List<AviatrixGatewaySnatInterfacePolicy>
    Computed attribute to store the previous interface policy.
    snatMode String
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies List<AviatrixGatewaySnatSnatPolicy>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa Boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    connectionPolicies AviatrixGatewaySnatConnectionPolicy[]
    Computed attribute to store the previous connection policy.
    gwName string
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    interfacePolicies AviatrixGatewaySnatInterfacePolicy[]
    Computed attribute to store the previous interface policy.
    snatMode string
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies AviatrixGatewaySnatSnatPolicy[]
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    connection_policies Sequence[AviatrixGatewaySnatConnectionPolicyArgs]
    Computed attribute to store the previous connection policy.
    gw_name str
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    interface_policies Sequence[AviatrixGatewaySnatInterfacePolicyArgs]
    Computed attribute to store the previous interface policy.
    snat_mode str
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snat_policies Sequence[AviatrixGatewaySnatSnatPolicyArgs]
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    sync_to_ha bool
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.
    connectionPolicies List<Property Map>
    Computed attribute to store the previous connection policy.
    gwName String
    Name of the Aviatrix gateway the custom SNAT will be configured for.
    interfacePolicies List<Property Map>
    Computed attribute to store the previous interface policy.
    snatMode String
    NAT mode. Valid values: "customized_snat". Default value: "customized_snat".
    snatPolicies List<Property Map>
    Policy rule applied for enabling source NAT (mode: "customized_snat"). Currently only supports AWS(1) and Azure(8).
    syncToHa Boolean
    Sync the policies to the HA gateway. Valid values: true, false. Default: false.

    Supporting Types

    AviatrixGatewaySnatConnectionPolicy, AviatrixGatewaySnatConnectionPolicyArgs

    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface_ String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    apply_route_entry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection str
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dst_cidr str
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dst_port str
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    exclude_rtb str
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface str
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark str
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol str
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snat_ips str
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snat_port str
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    src_cidr str
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    src_port str
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.

    AviatrixGatewaySnatInterfacePolicy, AviatrixGatewaySnatInterfacePolicyArgs

    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface_ String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    apply_route_entry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection str
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dst_cidr str
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dst_port str
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    exclude_rtb str
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface str
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark str
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol str
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snat_ips str
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snat_port str
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    src_cidr str
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    src_port str
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.

    AviatrixGatewaySnatSnatPolicy, AviatrixGatewaySnatSnatPolicyArgs

    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    ApplyRouteEntry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    Connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    DstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    DstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    ExcludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    Interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    Mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    Protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    SnatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SnatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    SrcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    SrcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface_ String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection string
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr string
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort string
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb string
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface string
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark string
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol string
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps string
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort string
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr string
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort string
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    apply_route_entry bool
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection str
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dst_cidr str
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dst_port str
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    exclude_rtb str
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface str
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark str
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol str
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snat_ips str
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snat_port str
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    src_cidr str
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    src_port str
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.
    applyRouteEntry Boolean
    This is an option to program the route entry 'DST CIDR pointing to Aviatrix Gateway' into Cloud platform routing table. Type: Boolean. Default: True. Available as of provider version R2.21.0+.
    connection String
    This is a qualifier condition that specifies output connection where the rule applies. Default value: "None".
    dstCidr String
    This is a qualifier condition that specifies a destination IP address range where the rule applies. When not specified, this field is not used.
    dstPort String
    This is a qualifier condition that specifies a destination port where the rule applies. When not specified, this field is not used.
    excludeRtb String
    This field specifies which VPC private route table will not be programmed with the default route entry.
    interface String
    This is a qualifier condition that specifies output interface where the rule applies. When not specified, this field is not used. Must be empty when connection is set.
    mark String
    This is a qualifier condition that specifies a tag or mark of a TCP session where the rule applies. When not specified, this field is not used.
    protocol String
    This is a qualifier condition that specifies a destination port protocol where the rule applies. Valid values: 'all', 'tcp', 'udp', 'icmp'. 'Default: 'all'.
    snatIps String
    This is a rule field that specifies the changed source IP address when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    snatPort String
    This is a rule field that specifies the changed source port when all specified qualifier conditions meet. When not specified, this field is not used. One of the rule fields must be specified for this rule to take effect.
    srcCidr String
    This is a qualifier condition that specifies a source IP address range where the rule applies. When not specified, this field is not used.
    srcPort String
    This is a qualifier condition that specifies a source port that the rule applies. When not specified, this field is not used.

    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