fivetran 1.6.1, Mar 31 25

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

fivetran.ExternalLogging

Explore with Pulumi AI

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

fivetran/terraform-provider-fivetran

Import

To import an existing fivetran_external_logging resource into your Terraform state, you need to get External Logging Group ID on the external logging page in your Fivetran dashboard.

To retrieve existing groups, use the fivetran_groups data source.

Define an empty resource in your .tf configuration:

hcl

resource “fivetran_external_logging” “my_imported_external_logging” {

}

Run the pulumi import command with the following parameters:

$ pulumi import fivetran:index/externalLogging:ExternalLogging my_imported_external_logging {your External Logging Group ID}

Use the terraform state show command to get the values from the state:

terraform state show ‘fivetran_external_logging.my_imported_external_logging’

Copy the values and paste them to your .tf configuration.

-> The config object in the state contains all properties defined in the schema. You need to remove properties from the config that are not related to destinations. See the Fivetran REST API documentation for reference to find the properties you need to keep in the config section.

Create ExternalLogging Resource

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

new ExternalLogging(name: string, args: ExternalLoggingArgs, opts?: CustomResourceOptions);

@overload
def ExternalLogging(resource_name: str,
                    args: ExternalLoggingArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ExternalLogging(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    group_id: Optional[str] = None,
                    service: Optional[str] = None,
                    config: Optional[ExternalLoggingConfigArgs] = None,
                    enabled: Optional[bool] = None,
                    run_setup_tests: Optional[bool] = None)

func NewExternalLogging(ctx *Context, name string, args ExternalLoggingArgs, opts ...ResourceOption) (*ExternalLogging, error)

public ExternalLogging(string name, ExternalLoggingArgs args, CustomResourceOptions? opts = null)

public ExternalLogging(String name, ExternalLoggingArgs args)
public ExternalLogging(String name, ExternalLoggingArgs args, CustomResourceOptions options)

type: fivetran:ExternalLogging
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 ExternalLoggingArgs: 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 ExternalLoggingArgs: 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 ExternalLoggingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExternalLoggingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExternalLoggingArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var externalLoggingResource = new Fivetran.ExternalLogging("externalLoggingResource", new()
{
    GroupId = "string",
    Service = "string",
    Config = new Fivetran.Inputs.ExternalLoggingConfigArgs
    {
        ApiKey = "string",
        Channel = "string",
        EnableSsl = false,
        ExternalId = "string",
        Host = "string",
        Hostname = "string",
        LogGroupName = "string",
        Port = 0,
        PrimaryKey = "string",
        ProjectId = "string",
        Region = "string",
        RoleArn = "string",
        SubDomain = "string",
        Token = "string",
        WorkspaceId = "string",
    },
    Enabled = false,
    RunSetupTests = false,
});

example, err := fivetran.NewExternalLogging(ctx, "externalLoggingResource", &fivetran.ExternalLoggingArgs{
GroupId: pulumi.String("string"),
Service: pulumi.String("string"),
Config: &.ExternalLoggingConfigArgs{
ApiKey: pulumi.String("string"),
Channel: pulumi.String("string"),
EnableSsl: pulumi.Bool(false),
ExternalId: pulumi.String("string"),
Host: pulumi.String("string"),
Hostname: pulumi.String("string"),
LogGroupName: pulumi.String("string"),
Port: pulumi.Float64(0),
PrimaryKey: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Region: pulumi.String("string"),
RoleArn: pulumi.String("string"),
SubDomain: pulumi.String("string"),
Token: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
RunSetupTests: pulumi.Bool(false),
})

var externalLoggingResource = new ExternalLogging("externalLoggingResource", ExternalLoggingArgs.builder()
    .groupId("string")
    .service("string")
    .config(ExternalLoggingConfigArgs.builder()
        .apiKey("string")
        .channel("string")
        .enableSsl(false)
        .externalId("string")
        .host("string")
        .hostname("string")
        .logGroupName("string")
        .port(0)
        .primaryKey("string")
        .projectId("string")
        .region("string")
        .roleArn("string")
        .subDomain("string")
        .token("string")
        .workspaceId("string")
        .build())
    .enabled(false)
    .runSetupTests(false)
    .build());

external_logging_resource = fivetran.ExternalLogging("externalLoggingResource",
    group_id="string",
    service="string",
    config={
        "api_key": "string",
        "channel": "string",
        "enable_ssl": False,
        "external_id": "string",
        "host": "string",
        "hostname": "string",
        "log_group_name": "string",
        "port": 0,
        "primary_key": "string",
        "project_id": "string",
        "region": "string",
        "role_arn": "string",
        "sub_domain": "string",
        "token": "string",
        "workspace_id": "string",
    },
    enabled=False,
    run_setup_tests=False)

const externalLoggingResource = new fivetran.ExternalLogging("externalLoggingResource", {
    groupId: "string",
    service: "string",
    config: {
        apiKey: "string",
        channel: "string",
        enableSsl: false,
        externalId: "string",
        host: "string",
        hostname: "string",
        logGroupName: "string",
        port: 0,
        primaryKey: "string",
        projectId: "string",
        region: "string",
        roleArn: "string",
        subDomain: "string",
        token: "string",
        workspaceId: "string",
    },
    enabled: false,
    runSetupTests: false,
});

type: fivetran:ExternalLogging
properties:
    config:
        apiKey: string
        channel: string
        enableSsl: false
        externalId: string
        host: string
        hostname: string
        logGroupName: string
        port: 0
        primaryKey: string
        projectId: string
        region: string
        roleArn: string
        subDomain: string
        token: string
        workspaceId: string
    enabled: false
    groupId: string
    runSetupTests: false
    service: string

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

GroupId string: The unique identifier for the log service within the Fivetran system.
Service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
Config ExternalLoggingConfig
Enabled bool: The boolean value specifying whether the log service is enabled.
RunSetupTests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.

GroupId string: The unique identifier for the log service within the Fivetran system.
Service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
Config ExternalLoggingConfigArgs
Enabled bool: The boolean value specifying whether the log service is enabled.
RunSetupTests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.

groupId String: The unique identifier for the log service within the Fivetran system.
service String: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
config ExternalLoggingConfig
enabled Boolean: The boolean value specifying whether the log service is enabled.
runSetupTests Boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.

groupId string: The unique identifier for the log service within the Fivetran system.
service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
config ExternalLoggingConfig
enabled boolean: The boolean value specifying whether the log service is enabled.
runSetupTests boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.

group_id str: The unique identifier for the log service within the Fivetran system.
service str: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
config ExternalLoggingConfigArgs
enabled bool: The boolean value specifying whether the log service is enabled.
run_setup_tests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.

groupId String: The unique identifier for the log service within the Fivetran system.
service String: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.
config Property Map
enabled Boolean: The boolean value specifying whether the log service is enabled.
runSetupTests Boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ExternalLogging Resource

Get an existing ExternalLogging resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ExternalLoggingState, opts?: CustomResourceOptions): ExternalLogging

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[ExternalLoggingConfigArgs] = None,
        enabled: Optional[bool] = None,
        group_id: Optional[str] = None,
        run_setup_tests: Optional[bool] = None,
        service: Optional[str] = None) -> ExternalLogging

func GetExternalLogging(ctx *Context, name string, id IDInput, state *ExternalLoggingState, opts ...ResourceOption) (*ExternalLogging, error)

public static ExternalLogging Get(string name, Input<string> id, ExternalLoggingState? state, CustomResourceOptions? opts = null)

public static ExternalLogging get(String name, Output<String> id, ExternalLoggingState state, CustomResourceOptions options)

resources:  _:    type: fivetran:ExternalLogging    get:      id: ${id}

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:

Config ExternalLoggingConfig
Enabled bool: The boolean value specifying whether the log service is enabled.
GroupId string: The unique identifier for the log service within the Fivetran system.
RunSetupTests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.
Service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

Config ExternalLoggingConfigArgs
Enabled bool: The boolean value specifying whether the log service is enabled.
GroupId string: The unique identifier for the log service within the Fivetran system.
RunSetupTests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.
Service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

config ExternalLoggingConfig
enabled Boolean: The boolean value specifying whether the log service is enabled.
groupId String: The unique identifier for the log service within the Fivetran system.
runSetupTests Boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.
service String: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

config ExternalLoggingConfig
enabled boolean: The boolean value specifying whether the log service is enabled.
groupId string: The unique identifier for the log service within the Fivetran system.
runSetupTests boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.
service string: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

config ExternalLoggingConfigArgs
enabled bool: The boolean value specifying whether the log service is enabled.
group_id str: The unique identifier for the log service within the Fivetran system.
run_setup_tests bool: Specifies whether the setup tests should be run automatically. The default value is TRUE.
service str: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

config Property Map
enabled Boolean: The boolean value specifying whether the log service is enabled.
groupId String: The unique identifier for the log service within the Fivetran system.
runSetupTests Boolean: Specifies whether the setup tests should be run automatically. The default value is TRUE.
service String: The name for the log service type within the Fivetran system. We support the following log services: azuremonitorlog, cloudwatch, datadoglog, newrelic_log, splunkLog, stackdriver.

Supporting Types

ExternalLoggingConfig
, ExternalLoggingConfigArgs

ApiKey string: API Key
Channel string: Channel
EnableSsl bool: Enable SSL
ExternalId string: external_id
Host string: Server name
Hostname string: Server name
LogGroupName string: Log Group Name
Port double: Port
PrimaryKey string: Primary Key
ProjectId string: Project Id for Google Cloud Logging
Region string: Region
RoleArn string: Role Arn
SubDomain string: Sub Domain
Token string: Token
WorkspaceId string: Workspace ID

ApiKey string: API Key
Channel string: Channel
EnableSsl bool: Enable SSL
ExternalId string: external_id
Host string: Server name
Hostname string: Server name
LogGroupName string: Log Group Name
Port float64: Port
PrimaryKey string: Primary Key
ProjectId string: Project Id for Google Cloud Logging
Region string: Region
RoleArn string: Role Arn
SubDomain string: Sub Domain
Token string: Token
WorkspaceId string: Workspace ID

apiKey String: API Key
channel String: Channel
enableSsl Boolean: Enable SSL
externalId String: external_id
host String: Server name
hostname String: Server name
logGroupName String: Log Group Name
port Double: Port
primaryKey String: Primary Key
projectId String: Project Id for Google Cloud Logging
region String: Region
roleArn String: Role Arn
subDomain String: Sub Domain
token String: Token
workspaceId String: Workspace ID

apiKey string: API Key
channel string: Channel
enableSsl boolean: Enable SSL
externalId string: external_id
host string: Server name
hostname string: Server name
logGroupName string: Log Group Name
port number: Port
primaryKey string: Primary Key
projectId string: Project Id for Google Cloud Logging
region string: Region
roleArn string: Role Arn
subDomain string: Sub Domain
token string: Token
workspaceId string: Workspace ID

api_key str: API Key
channel str: Channel
enable_ssl bool: Enable SSL
external_id str: external_id
host str: Server name
hostname str: Server name
log_group_name str: Log Group Name
port float: Port
primary_key str: Primary Key
project_id str: Project Id for Google Cloud Logging
region str: Region
role_arn str: Role Arn
sub_domain str: Sub Domain
token str: Token
workspace_id str: Workspace ID

apiKey String: API Key
channel String: Channel
enableSsl Boolean: Enable SSL
externalId String: external_id
host String: Server name
hostname String: Server name
logGroupName String: Log Group Name
port Number: Port
primaryKey String: Primary Key
projectId String: Project Id for Google Cloud Logging
region String: Region
roleArn String: Role Arn
subDomain String: Sub Domain
token String: Token
workspaceId String: Workspace ID

Package Details

Repository: fivetran fivetran/terraform-provider-fivetran
License
Notes: This Pulumi package is based on the fivetran Terraform Provider.

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

fivetran/terraform-provider-fivetran

fivetran.ExternalLogging

On this page

On this page

Import

Create ExternalLogging Resource

Constructor syntax

Parameters

Constructor example

ExternalLogging Resource Properties

Inputs

Outputs

Look up Existing ExternalLogging Resource

Supporting Types

ExternalLoggingConfig
, ExternalLoggingConfigArgs

Package Details

On this page

On this page

fivetran.ExternalLogging

On this page

On this page

Import

Create ExternalLogging Resource

Constructor syntax

Parameters

Constructor example

ExternalLogging Resource Properties

Inputs

Outputs

Look up Existing ExternalLogging Resource

Supporting Types

ExternalLoggingConfig, ExternalLoggingConfigArgs

Package Details

On this page

On this page

ExternalLoggingConfig
, ExternalLoggingConfigArgs