1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixSumologicForwarder
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixSumologicForwarder

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_sumologic_forwarder resource allows the enabling and disabling of sumologic forwarder.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Enable sumologic forwarder
        var testSumologicForwarder = new Aviatrix.AviatrixSumologicForwarder("testSumologicForwarder", new()
        {
            AccessId = "0",
            AccessKey = "1.2.3.4",
        });
    
    });
    
    package main
    
    import (
    	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aviatrix.NewAviatrixSumologicForwarder(ctx, "testSumologicForwarder", &aviatrix.AviatrixSumologicForwarderArgs{
    			AccessId:  pulumi.String("0"),
    			AccessKey: pulumi.String("1.2.3.4"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aviatrix.AviatrixSumologicForwarder;
    import com.pulumi.aviatrix.AviatrixSumologicForwarderArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testSumologicForwarder = new AviatrixSumologicForwarder("testSumologicForwarder", AviatrixSumologicForwarderArgs.builder()        
                .accessId(0)
                .accessKey("1.2.3.4")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Enable sumologic forwarder
    test_sumologic_forwarder = aviatrix.AviatrixSumologicForwarder("testSumologicForwarder",
        access_id="0",
        access_key="1.2.3.4")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Enable sumologic forwarder
    const testSumologicForwarder = new aviatrix.AviatrixSumologicForwarder("test_sumologic_forwarder", {
        accessId: "0",
        accessKey: "1.2.3.4",
    });
    
    resources:
      # Enable sumologic forwarder
      testSumologicForwarder:
        type: aviatrix:AviatrixSumologicForwarder
        properties:
          accessId: 0
          accessKey: 1.2.3.4
    

    Create AviatrixSumologicForwarder Resource

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

    Constructor syntax

    new AviatrixSumologicForwarder(name: string, args: AviatrixSumologicForwarderArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixSumologicForwarder(resource_name: str,
                                   args: AviatrixSumologicForwarderArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixSumologicForwarder(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   access_id: Optional[str] = None,
                                   access_key: Optional[str] = None,
                                   custom_configuration: Optional[str] = None,
                                   excluded_gateways: Optional[Sequence[str]] = None,
                                   source_category: Optional[str] = None)
    func NewAviatrixSumologicForwarder(ctx *Context, name string, args AviatrixSumologicForwarderArgs, opts ...ResourceOption) (*AviatrixSumologicForwarder, error)
    public AviatrixSumologicForwarder(string name, AviatrixSumologicForwarderArgs args, CustomResourceOptions? opts = null)
    public AviatrixSumologicForwarder(String name, AviatrixSumologicForwarderArgs args)
    public AviatrixSumologicForwarder(String name, AviatrixSumologicForwarderArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixSumologicForwarder
    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 AviatrixSumologicForwarderArgs
    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 AviatrixSumologicForwarderArgs
    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 AviatrixSumologicForwarderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixSumologicForwarderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixSumologicForwarderArgs
    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 aviatrixSumologicForwarderResource = new Aviatrix.AviatrixSumologicForwarder("aviatrixSumologicForwarderResource", new()
    {
        AccessId = "string",
        AccessKey = "string",
        CustomConfiguration = "string",
        ExcludedGateways = new[]
        {
            "string",
        },
        SourceCategory = "string",
    });
    
    example, err := aviatrix.NewAviatrixSumologicForwarder(ctx, "aviatrixSumologicForwarderResource", &aviatrix.AviatrixSumologicForwarderArgs{
    	AccessId:            pulumi.String("string"),
    	AccessKey:           pulumi.String("string"),
    	CustomConfiguration: pulumi.String("string"),
    	ExcludedGateways: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SourceCategory: pulumi.String("string"),
    })
    
    var aviatrixSumologicForwarderResource = new AviatrixSumologicForwarder("aviatrixSumologicForwarderResource", AviatrixSumologicForwarderArgs.builder()
        .accessId("string")
        .accessKey("string")
        .customConfiguration("string")
        .excludedGateways("string")
        .sourceCategory("string")
        .build());
    
    aviatrix_sumologic_forwarder_resource = aviatrix.AviatrixSumologicForwarder("aviatrixSumologicForwarderResource",
        access_id="string",
        access_key="string",
        custom_configuration="string",
        excluded_gateways=["string"],
        source_category="string")
    
    const aviatrixSumologicForwarderResource = new aviatrix.AviatrixSumologicForwarder("aviatrixSumologicForwarderResource", {
        accessId: "string",
        accessKey: "string",
        customConfiguration: "string",
        excludedGateways: ["string"],
        sourceCategory: "string",
    });
    
    type: aviatrix:AviatrixSumologicForwarder
    properties:
        accessId: string
        accessKey: string
        customConfiguration: string
        excludedGateways:
            - string
        sourceCategory: string
    

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

    AccessId string
    Access ID.
    AccessKey string
    Access Key.
    CustomConfiguration string
    Custom configuration. The format should be key=value pairs.
    ExcludedGateways List<string>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    SourceCategory string
    Source category. "Aviatrix_syslog" by default.
    AccessId string
    Access ID.
    AccessKey string
    Access Key.
    CustomConfiguration string
    Custom configuration. The format should be key=value pairs.
    ExcludedGateways []string
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    SourceCategory string
    Source category. "Aviatrix_syslog" by default.
    accessId String
    Access ID.
    accessKey String
    Access Key.
    customConfiguration String
    Custom configuration. The format should be key=value pairs.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory String
    Source category. "Aviatrix_syslog" by default.
    accessId string
    Access ID.
    accessKey string
    Access Key.
    customConfiguration string
    Custom configuration. The format should be key=value pairs.
    excludedGateways string[]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory string
    Source category. "Aviatrix_syslog" by default.
    access_id str
    Access ID.
    access_key str
    Access Key.
    custom_configuration str
    Custom configuration. The format should be key=value pairs.
    excluded_gateways Sequence[str]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    source_category str
    Source category. "Aviatrix_syslog" by default.
    accessId String
    Access ID.
    accessKey String
    Access Key.
    customConfiguration String
    Custom configuration. The format should be key=value pairs.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory String
    Source category. "Aviatrix_syslog" by default.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of sumologic forwarder.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of sumologic forwarder.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of sumologic forwarder.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of sumologic forwarder.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of sumologic forwarder.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of sumologic forwarder.

    Look up Existing AviatrixSumologicForwarder Resource

    Get an existing AviatrixSumologicForwarder 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?: AviatrixSumologicForwarderState, opts?: CustomResourceOptions): AviatrixSumologicForwarder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_id: Optional[str] = None,
            access_key: Optional[str] = None,
            custom_configuration: Optional[str] = None,
            excluded_gateways: Optional[Sequence[str]] = None,
            source_category: Optional[str] = None,
            status: Optional[str] = None) -> AviatrixSumologicForwarder
    func GetAviatrixSumologicForwarder(ctx *Context, name string, id IDInput, state *AviatrixSumologicForwarderState, opts ...ResourceOption) (*AviatrixSumologicForwarder, error)
    public static AviatrixSumologicForwarder Get(string name, Input<string> id, AviatrixSumologicForwarderState? state, CustomResourceOptions? opts = null)
    public static AviatrixSumologicForwarder get(String name, Output<String> id, AviatrixSumologicForwarderState 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:
    AccessId string
    Access ID.
    AccessKey string
    Access Key.
    CustomConfiguration string
    Custom configuration. The format should be key=value pairs.
    ExcludedGateways List<string>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    SourceCategory string
    Source category. "Aviatrix_syslog" by default.
    Status string
    The status of sumologic forwarder.
    AccessId string
    Access ID.
    AccessKey string
    Access Key.
    CustomConfiguration string
    Custom configuration. The format should be key=value pairs.
    ExcludedGateways []string
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    SourceCategory string
    Source category. "Aviatrix_syslog" by default.
    Status string
    The status of sumologic forwarder.
    accessId String
    Access ID.
    accessKey String
    Access Key.
    customConfiguration String
    Custom configuration. The format should be key=value pairs.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory String
    Source category. "Aviatrix_syslog" by default.
    status String
    The status of sumologic forwarder.
    accessId string
    Access ID.
    accessKey string
    Access Key.
    customConfiguration string
    Custom configuration. The format should be key=value pairs.
    excludedGateways string[]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory string
    Source category. "Aviatrix_syslog" by default.
    status string
    The status of sumologic forwarder.
    access_id str
    Access ID.
    access_key str
    Access Key.
    custom_configuration str
    Custom configuration. The format should be key=value pairs.
    excluded_gateways Sequence[str]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    source_category str
    Source category. "Aviatrix_syslog" by default.
    status str
    The status of sumologic forwarder.
    accessId String
    Access ID.
    accessKey String
    Access Key.
    customConfiguration String
    Custom configuration. The format should be key=value pairs.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    sourceCategory String
    Source category. "Aviatrix_syslog" by default.
    status String
    The status of sumologic forwarder.

    Import

    sumologic_forwarder can be imported using “sumologic_forwarder”, e.g.

     $ pulumi import aviatrix:index/aviatrixSumologicForwarder:AviatrixSumologicForwarder test sumologic_forwarder
    

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

    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