1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceAmazonSqs
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.SourceAmazonSqs

Explore with Pulumi AI

SourceAmazonSqs Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceAmazonSqs;
import com.pulumi.airbyte.SourceAmazonSqsArgs;
import com.pulumi.airbyte.inputs.SourceAmazonSqsConfigurationArgs;
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 mySourceAmazonsqs = new SourceAmazonSqs("mySourceAmazonsqs", SourceAmazonSqsArgs.builder()
            .configuration(SourceAmazonSqsConfigurationArgs.builder()
                .access_key("xxxxxHRNxxx3TBxxxxxx")
                .attributes_to_return("attr1,attr2")
                .max_batch_size(5)
                .max_wait_time(5)
                .queue_url("https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue")
                .region("ap-southeast-2")
                .secret_key("hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz")
                .target("GetQueueAttributes")
                .visibility_timeout(20)
                .build())
            .definitionId("838e1ff6-5ade-49bb-b0dc-2f1fb8c96dde")
            .secretId("...my_secret_id...")
            .workspaceId("d064f44a-5875-4cf2-8a32-a321d2eb3460")
            .build());

    }
}
Copy
resources:
  mySourceAmazonsqs:
    type: airbyte:SourceAmazonSqs
    properties:
      configuration:
        access_key: xxxxxHRNxxx3TBxxxxxx
        attributes_to_return: attr1,attr2
        max_batch_size: 5
        max_wait_time: 5
        queue_url: https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue
        region: ap-southeast-2
        secret_key: hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz
        target: GetQueueAttributes
        visibility_timeout: 20
      definitionId: 838e1ff6-5ade-49bb-b0dc-2f1fb8c96dde
      secretId: '...my_secret_id...'
      workspaceId: d064f44a-5875-4cf2-8a32-a321d2eb3460
Copy

Create SourceAmazonSqs Resource

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

Constructor syntax

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

@overload
def SourceAmazonSqs(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceAmazonSqsConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourceAmazonSqs(ctx *Context, name string, args SourceAmazonSqsArgs, opts ...ResourceOption) (*SourceAmazonSqs, error)
public SourceAmazonSqs(string name, SourceAmazonSqsArgs args, CustomResourceOptions? opts = null)
public SourceAmazonSqs(String name, SourceAmazonSqsArgs args)
public SourceAmazonSqs(String name, SourceAmazonSqsArgs args, CustomResourceOptions options)
type: airbyte:SourceAmazonSqs
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. SourceAmazonSqsArgs
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. SourceAmazonSqsArgs
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. SourceAmazonSqsArgs
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. SourceAmazonSqsArgs
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. SourceAmazonSqsArgs
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 sourceAmazonSqsResource = new Airbyte.SourceAmazonSqs("sourceAmazonSqsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAmazonSqsConfigurationArgs
    {
        AccessKey = "string",
        QueueUrl = "string",
        SecretKey = "string",
        AttributesToReturn = "string",
        MaxBatchSize = 0,
        MaxWaitTime = 0,
        Region = "string",
        Target = "string",
        VisibilityTimeout = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceAmazonSqs(ctx, "sourceAmazonSqsResource", &airbyte.SourceAmazonSqsArgs{
Configuration: &.SourceAmazonSqsConfigurationArgs{
AccessKey: pulumi.String("string"),
QueueUrl: pulumi.String("string"),
SecretKey: pulumi.String("string"),
AttributesToReturn: pulumi.String("string"),
MaxBatchSize: pulumi.Float64(0),
MaxWaitTime: pulumi.Float64(0),
Region: pulumi.String("string"),
Target: pulumi.String("string"),
VisibilityTimeout: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceAmazonSqsResource = new SourceAmazonSqs("sourceAmazonSqsResource", SourceAmazonSqsArgs.builder()
    .configuration(SourceAmazonSqsConfigurationArgs.builder()
        .accessKey("string")
        .queueUrl("string")
        .secretKey("string")
        .attributesToReturn("string")
        .maxBatchSize(0)
        .maxWaitTime(0)
        .region("string")
        .target("string")
        .visibilityTimeout(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_amazon_sqs_resource = airbyte.SourceAmazonSqs("sourceAmazonSqsResource",
    configuration={
        "access_key": "string",
        "queue_url": "string",
        "secret_key": "string",
        "attributes_to_return": "string",
        "max_batch_size": 0,
        "max_wait_time": 0,
        "region": "string",
        "target": "string",
        "visibility_timeout": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceAmazonSqsResource = new airbyte.SourceAmazonSqs("sourceAmazonSqsResource", {
    configuration: {
        accessKey: "string",
        queueUrl: "string",
        secretKey: "string",
        attributesToReturn: "string",
        maxBatchSize: 0,
        maxWaitTime: 0,
        region: "string",
        target: "string",
        visibilityTimeout: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceAmazonSqs
properties:
    configuration:
        accessKey: string
        attributesToReturn: string
        maxBatchSize: 0
        maxWaitTime: 0
        queueUrl: string
        region: string
        secretKey: string
        target: string
        visibilityTimeout: 0
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceAmazonSqsConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourceAmazonSqsConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceAmazonSqsConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceAmazonSqsConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceAmazonSqsConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

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

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceAmazonSqs Resource

Get an existing SourceAmazonSqs 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?: SourceAmazonSqsState, opts?: CustomResourceOptions): SourceAmazonSqs
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAmazonSqsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceAmazonSqsResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceAmazonSqs
func GetSourceAmazonSqs(ctx *Context, name string, id IDInput, state *SourceAmazonSqsState, opts ...ResourceOption) (*SourceAmazonSqs, error)
public static SourceAmazonSqs Get(string name, Input<string> id, SourceAmazonSqsState? state, CustomResourceOptions? opts = null)
public static SourceAmazonSqs get(String name, Output<String> id, SourceAmazonSqsState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceAmazonSqs    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:
Configuration SourceAmazonSqsConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceAmazonSqsConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceAmazonSqsResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceAmazonSqsConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceAmazonSqsConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceAmazonSqsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceAmazonSqsConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourceAmazonSqsResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceAmazonSqsConfiguration
, SourceAmazonSqsConfigurationArgs

AccessKey This property is required. string
The Access Key ID of the AWS IAM Role to use for pulling messages
QueueUrl This property is required. string
URL of the SQS Queue
SecretKey This property is required. string
The Secret Key of the AWS IAM Role to use for pulling messages
AttributesToReturn string
Comma separated list of Mesage Attribute names to return. Default: "All"
MaxBatchSize double
Max amount of messages to get in one batch (10 max). Default: 10
MaxWaitTime double
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
Region string
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
Target string
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
VisibilityTimeout double
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20
AccessKey This property is required. string
The Access Key ID of the AWS IAM Role to use for pulling messages
QueueUrl This property is required. string
URL of the SQS Queue
SecretKey This property is required. string
The Secret Key of the AWS IAM Role to use for pulling messages
AttributesToReturn string
Comma separated list of Mesage Attribute names to return. Default: "All"
MaxBatchSize float64
Max amount of messages to get in one batch (10 max). Default: 10
MaxWaitTime float64
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
Region string
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
Target string
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
VisibilityTimeout float64
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20
accessKey This property is required. String
The Access Key ID of the AWS IAM Role to use for pulling messages
queueUrl This property is required. String
URL of the SQS Queue
secretKey This property is required. String
The Secret Key of the AWS IAM Role to use for pulling messages
attributesToReturn String
Comma separated list of Mesage Attribute names to return. Default: "All"
maxBatchSize Double
Max amount of messages to get in one batch (10 max). Default: 10
maxWaitTime Double
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
region String
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
target String
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
visibilityTimeout Double
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20
accessKey This property is required. string
The Access Key ID of the AWS IAM Role to use for pulling messages
queueUrl This property is required. string
URL of the SQS Queue
secretKey This property is required. string
The Secret Key of the AWS IAM Role to use for pulling messages
attributesToReturn string
Comma separated list of Mesage Attribute names to return. Default: "All"
maxBatchSize number
Max amount of messages to get in one batch (10 max). Default: 10
maxWaitTime number
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
region string
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
target string
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
visibilityTimeout number
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20
access_key This property is required. str
The Access Key ID of the AWS IAM Role to use for pulling messages
queue_url This property is required. str
URL of the SQS Queue
secret_key This property is required. str
The Secret Key of the AWS IAM Role to use for pulling messages
attributes_to_return str
Comma separated list of Mesage Attribute names to return. Default: "All"
max_batch_size float
Max amount of messages to get in one batch (10 max). Default: 10
max_wait_time float
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
region str
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
target str
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
visibility_timeout float
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20
accessKey This property is required. String
The Access Key ID of the AWS IAM Role to use for pulling messages
queueUrl This property is required. String
URL of the SQS Queue
secretKey This property is required. String
The Secret Key of the AWS IAM Role to use for pulling messages
attributesToReturn String
Comma separated list of Mesage Attribute names to return. Default: "All"
maxBatchSize Number
Max amount of messages to get in one batch (10 max). Default: 10
maxWaitTime Number
Max amount of time in seconds to wait for messages in a single poll (20 max). Default: 20
region String
AWS Region of the SQS Queue. Default: "us-east-1"; must be one of ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
target String
Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html. Default: "ReceiveMessage"; must be one of ["GetQueueAttributes", "ReceiveMessage"]
visibilityTimeout Number
Modify the Visibility Timeout of the individual message from the Queue's default (seconds). Default: 20

SourceAmazonSqsResourceAllocation
, SourceAmazonSqsResourceAllocationArgs

Default SourceAmazonSqsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceAmazonSqsResourceAllocationJobSpecific>
Default SourceAmazonSqsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceAmazonSqsResourceAllocationJobSpecific
default_ SourceAmazonSqsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceAmazonSqsResourceAllocationJobSpecific>
default SourceAmazonSqsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceAmazonSqsResourceAllocationJobSpecific[]
default SourceAmazonSqsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceAmazonSqsResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceAmazonSqsResourceAllocationDefault
, SourceAmazonSqsResourceAllocationDefaultArgs

SourceAmazonSqsResourceAllocationJobSpecific
, SourceAmazonSqsResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceAmazonSqsResourceAllocationJobSpecificResourceRequirements
, SourceAmazonSqsResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceAmazonSqs:SourceAmazonSqs my_airbyte_source_amazon_sqs ""
Copy

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

Package Details

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