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

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",
    });

});
Copy
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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  # Enable sumologic forwarder
  testSumologicForwarder:
    type: aviatrix:AviatrixSumologicForwarder
    properties:
      accessId: 0
      accessKey: 1.2.3.4
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. AviatrixSumologicForwarderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AviatrixSumologicForwarderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixSumologicForwarderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
var aviatrixSumologicForwarderResource = new AviatrixSumologicForwarder("aviatrixSumologicForwarderResource", AviatrixSumologicForwarderArgs.builder()
    .accessId("string")
    .accessKey("string")
    .customConfiguration("string")
    .excludedGateways("string")
    .sourceCategory("string")
    .build());
Copy
aviatrix_sumologic_forwarder_resource = aviatrix.AviatrixSumologicForwarder("aviatrixSumologicForwarderResource",
    access_id="string",
    access_key="string",
    custom_configuration="string",
    excluded_gateways=["string"],
    source_category="string")
Copy
const aviatrixSumologicForwarderResource = new aviatrix.AviatrixSumologicForwarder("aviatrixSumologicForwarderResource", {
    accessId: "string",
    accessKey: "string",
    customConfiguration: "string",
    excludedGateways: ["string"],
    sourceCategory: "string",
});
Copy
type: aviatrix:AviatrixSumologicForwarder
properties:
    accessId: string
    accessKey: string
    customConfiguration: string
    excludedGateways:
        - string
    sourceCategory: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
Access ID.
AccessKey
This property is required.
Changes to this property will trigger replacement.
string
Access Key.
CustomConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
ExcludedGateways Changes to this property will trigger replacement. List<string>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
SourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
AccessId
This property is required.
Changes to this property will trigger replacement.
string
Access ID.
AccessKey
This property is required.
Changes to this property will trigger replacement.
string
Access Key.
CustomConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
ExcludedGateways Changes to this property will trigger replacement. []string
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
SourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
accessId
This property is required.
Changes to this property will trigger replacement.
String
Access ID.
accessKey
This property is required.
Changes to this property will trigger replacement.
String
Access Key.
customConfiguration Changes to this property will trigger replacement. String
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. List<String>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. String
Source category. "Aviatrix_syslog" by default.
accessId
This property is required.
Changes to this property will trigger replacement.
string
Access ID.
accessKey
This property is required.
Changes to this property will trigger replacement.
string
Access Key.
customConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. string[]
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
access_id
This property is required.
Changes to this property will trigger replacement.
str
Access ID.
access_key
This property is required.
Changes to this property will trigger replacement.
str
Access Key.
custom_configuration Changes to this property will trigger replacement. str
Custom configuration. The format should be key=value pairs.
excluded_gateways Changes to this property will trigger replacement. Sequence[str]
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
source_category Changes to this property will trigger replacement. str
Source category. "Aviatrix_syslog" by default.
accessId
This property is required.
Changes to this property will trigger replacement.
String
Access ID.
accessKey
This property is required.
Changes to this property will trigger replacement.
String
Access Key.
customConfiguration Changes to this property will trigger replacement. String
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. List<String>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. 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)
resources:  _:    type: aviatrix:AviatrixSumologicForwarder    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
Access ID.
AccessKey Changes to this property will trigger replacement. string
Access Key.
CustomConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
ExcludedGateways Changes to this property will trigger replacement. List<string>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
SourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
Status string
The status of sumologic forwarder.
AccessId Changes to this property will trigger replacement. string
Access ID.
AccessKey Changes to this property will trigger replacement. string
Access Key.
CustomConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
ExcludedGateways Changes to this property will trigger replacement. []string
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
SourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
Status string
The status of sumologic forwarder.
accessId Changes to this property will trigger replacement. String
Access ID.
accessKey Changes to this property will trigger replacement. String
Access Key.
customConfiguration Changes to this property will trigger replacement. String
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. List<String>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. String
Source category. "Aviatrix_syslog" by default.
status String
The status of sumologic forwarder.
accessId Changes to this property will trigger replacement. string
Access ID.
accessKey Changes to this property will trigger replacement. string
Access Key.
customConfiguration Changes to this property will trigger replacement. string
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. string[]
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. string
Source category. "Aviatrix_syslog" by default.
status string
The status of sumologic forwarder.
access_id Changes to this property will trigger replacement. str
Access ID.
access_key Changes to this property will trigger replacement. str
Access Key.
custom_configuration Changes to this property will trigger replacement. str
Custom configuration. The format should be key=value pairs.
excluded_gateways Changes to this property will trigger replacement. Sequence[str]
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
source_category Changes to this property will trigger replacement. str
Source category. "Aviatrix_syslog" by default.
status str
The status of sumologic forwarder.
accessId Changes to this property will trigger replacement. String
Access ID.
accessKey Changes to this property will trigger replacement. String
Access Key.
customConfiguration Changes to this property will trigger replacement. String
Custom configuration. The format should be key=value pairs.
excludedGateways Changes to this property will trigger replacement. List<String>
List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
sourceCategory Changes to this property will trigger replacement. 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
Copy

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.