Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Temporalcloud Provider
  3. API Docs
  4. NamespaceExportSink
temporalcloud 0.7.0 published on Friday, Apr 4, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

temporalcloud.NamespaceExportSink

Explore with Pulumi AI

temporalcloud 0.7.0 published on Friday, Apr 4, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

Provisions a namespace export sink.

Create NamespaceExportSink Resource

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

Constructor syntax

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

@overload
def NamespaceExportSink(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        namespace: Optional[str] = None,
                        sink_name: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        gcs: Optional[NamespaceExportSinkGcsArgs] = None,
                        s3: Optional[NamespaceExportSinkS3Args] = None,
                        timeouts: Optional[NamespaceExportSinkTimeoutsArgs] = None)
func NewNamespaceExportSink(ctx *Context, name string, args NamespaceExportSinkArgs, opts ...ResourceOption) (*NamespaceExportSink, error)
public NamespaceExportSink(string name, NamespaceExportSinkArgs args, CustomResourceOptions? opts = null)
public NamespaceExportSink(String name, NamespaceExportSinkArgs args)
public NamespaceExportSink(String name, NamespaceExportSinkArgs args, CustomResourceOptions options)

type: temporalcloud:NamespaceExportSink
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. NamespaceExportSinkArgs
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. NamespaceExportSinkArgs
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. NamespaceExportSinkArgs
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. NamespaceExportSinkArgs
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. NamespaceExportSinkArgs
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 namespaceExportSinkResource = new Temporalcloud.NamespaceExportSink("namespaceExportSinkResource", new()
{
    Namespace = "string",
    SinkName = "string",
    Enabled = false,
    Gcs = new Temporalcloud.Inputs.NamespaceExportSinkGcsArgs
    {
        BucketName = "string",
        GcpProjectId = "string",
        Region = "string",
        ServiceAccountId = "string",
    },
    S3 = new Temporalcloud.Inputs.NamespaceExportSinkS3Args
    {
        AwsAccountId = "string",
        BucketName = "string",
        KmsArn = "string",
        Region = "string",
        RoleName = "string",
    },
    Timeouts = new Temporalcloud.Inputs.NamespaceExportSinkTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});
Copy
example, err := temporalcloud.NewNamespaceExportSink(ctx, "namespaceExportSinkResource", &temporalcloud.NamespaceExportSinkArgs{
Namespace: pulumi.String("string"),
SinkName: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Gcs: &.NamespaceExportSinkGcsArgs{
BucketName: pulumi.String("string"),
GcpProjectId: pulumi.String("string"),
Region: pulumi.String("string"),
ServiceAccountId: pulumi.String("string"),
},
S3: &.NamespaceExportSinkS3Args{
AwsAccountId: pulumi.String("string"),
BucketName: pulumi.String("string"),
KmsArn: pulumi.String("string"),
Region: pulumi.String("string"),
RoleName: pulumi.String("string"),
},
Timeouts: &.NamespaceExportSinkTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
Copy
var namespaceExportSinkResource = new NamespaceExportSink("namespaceExportSinkResource", NamespaceExportSinkArgs.builder()
    .namespace("string")
    .sinkName("string")
    .enabled(false)
    .gcs(NamespaceExportSinkGcsArgs.builder()
        .bucketName("string")
        .gcpProjectId("string")
        .region("string")
        .serviceAccountId("string")
        .build())
    .s3(NamespaceExportSinkS3Args.builder()
        .awsAccountId("string")
        .bucketName("string")
        .kmsArn("string")
        .region("string")
        .roleName("string")
        .build())
    .timeouts(NamespaceExportSinkTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());
Copy
namespace_export_sink_resource = temporalcloud.NamespaceExportSink("namespaceExportSinkResource",
    namespace="string",
    sink_name="string",
    enabled=False,
    gcs={
        "bucket_name": "string",
        "gcp_project_id": "string",
        "region": "string",
        "service_account_id": "string",
    },
    s3={
        "aws_account_id": "string",
        "bucket_name": "string",
        "kms_arn": "string",
        "region": "string",
        "role_name": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })
Copy
const namespaceExportSinkResource = new temporalcloud.NamespaceExportSink("namespaceExportSinkResource", {
    namespace: "string",
    sinkName: "string",
    enabled: false,
    gcs: {
        bucketName: "string",
        gcpProjectId: "string",
        region: "string",
        serviceAccountId: "string",
    },
    s3: {
        awsAccountId: "string",
        bucketName: "string",
        kmsArn: "string",
        region: "string",
        roleName: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});
Copy
type: temporalcloud:NamespaceExportSink
properties:
    enabled: false
    gcs:
        bucketName: string
        gcpProjectId: string
        region: string
        serviceAccountId: string
    namespace: string
    s3:
        awsAccountId: string
        bucketName: string
        kmsArn: string
        region: string
        roleName: string
    sinkName: string
    timeouts:
        create: string
        delete: string
Copy

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

Namespace This property is required. string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
SinkName This property is required. string
The unique name of the export sink, it can't be changed once set.
Enabled bool
A flag indicating whether the export sink is enabled or not.
Gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
S3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
Timeouts NamespaceExportSinkTimeouts
Namespace This property is required. string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
SinkName This property is required. string
The unique name of the export sink, it can't be changed once set.
Enabled bool
A flag indicating whether the export sink is enabled or not.
Gcs NamespaceExportSinkGcsArgs
The GCS configuration details when destination_type is GCS.
S3 NamespaceExportSinkS3Args
The S3 configuration details when destination_type is S3.
Timeouts NamespaceExportSinkTimeoutsArgs
namespace This property is required. String
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
sinkName This property is required. String
The unique name of the export sink, it can't be changed once set.
enabled Boolean
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
s3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
timeouts NamespaceExportSinkTimeouts
namespace This property is required. string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
sinkName This property is required. string
The unique name of the export sink, it can't be changed once set.
enabled boolean
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
s3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
timeouts NamespaceExportSinkTimeouts
namespace This property is required. str
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
sink_name This property is required. str
The unique name of the export sink, it can't be changed once set.
enabled bool
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcsArgs
The GCS configuration details when destination_type is GCS.
s3 NamespaceExportSinkS3Args
The S3 configuration details when destination_type is S3.
timeouts NamespaceExportSinkTimeoutsArgs
namespace This property is required. String
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
sinkName This property is required. String
The unique name of the export sink, it can't be changed once set.
enabled Boolean
A flag indicating whether the export sink is enabled or not.
gcs Property Map
The GCS configuration details when destination_type is GCS.
s3 Property Map
The S3 configuration details when destination_type is S3.
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the NamespaceExportSink 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 NamespaceExportSink Resource

Get an existing NamespaceExportSink 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?: NamespaceExportSinkState, opts?: CustomResourceOptions): NamespaceExportSink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        gcs: Optional[NamespaceExportSinkGcsArgs] = None,
        namespace: Optional[str] = None,
        s3: Optional[NamespaceExportSinkS3Args] = None,
        sink_name: Optional[str] = None,
        timeouts: Optional[NamespaceExportSinkTimeoutsArgs] = None) -> NamespaceExportSink
func GetNamespaceExportSink(ctx *Context, name string, id IDInput, state *NamespaceExportSinkState, opts ...ResourceOption) (*NamespaceExportSink, error)
public static NamespaceExportSink Get(string name, Input<string> id, NamespaceExportSinkState? state, CustomResourceOptions? opts = null)
public static NamespaceExportSink get(String name, Output<String> id, NamespaceExportSinkState state, CustomResourceOptions options)
resources:  _:    type: temporalcloud:NamespaceExportSink    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:
Enabled bool
A flag indicating whether the export sink is enabled or not.
Gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
Namespace string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
S3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
SinkName string
The unique name of the export sink, it can't be changed once set.
Timeouts NamespaceExportSinkTimeouts
Enabled bool
A flag indicating whether the export sink is enabled or not.
Gcs NamespaceExportSinkGcsArgs
The GCS configuration details when destination_type is GCS.
Namespace string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
S3 NamespaceExportSinkS3Args
The S3 configuration details when destination_type is S3.
SinkName string
The unique name of the export sink, it can't be changed once set.
Timeouts NamespaceExportSinkTimeoutsArgs
enabled Boolean
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
namespace String
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
s3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
sinkName String
The unique name of the export sink, it can't be changed once set.
timeouts NamespaceExportSinkTimeouts
enabled boolean
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcs
The GCS configuration details when destination_type is GCS.
namespace string
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
s3 NamespaceExportSinkS3
The S3 configuration details when destination_type is S3.
sinkName string
The unique name of the export sink, it can't be changed once set.
timeouts NamespaceExportSinkTimeouts
enabled bool
A flag indicating whether the export sink is enabled or not.
gcs NamespaceExportSinkGcsArgs
The GCS configuration details when destination_type is GCS.
namespace str
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
s3 NamespaceExportSinkS3Args
The S3 configuration details when destination_type is S3.
sink_name str
The unique name of the export sink, it can't be changed once set.
timeouts NamespaceExportSinkTimeoutsArgs
enabled Boolean
A flag indicating whether the export sink is enabled or not.
gcs Property Map
The GCS configuration details when destination_type is GCS.
namespace String
The namespace under which the sink is configured. It's needed to be in the format of \n\n.\n\n
s3 Property Map
The S3 configuration details when destination_type is S3.
sinkName String
The unique name of the export sink, it can't be changed once set.
timeouts Property Map

Supporting Types

NamespaceExportSinkGcs
, NamespaceExportSinkGcsArgs

BucketName This property is required. string
The name of the destination GCS bucket where Temporal will send data.
GcpProjectId This property is required. string
The GCP project ID associated with the GCS bucket and service account.
Region This property is required. string
The region of the gcs bucket
ServiceAccountId This property is required. string
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.
BucketName This property is required. string
The name of the destination GCS bucket where Temporal will send data.
GcpProjectId This property is required. string
The GCP project ID associated with the GCS bucket and service account.
Region This property is required. string
The region of the gcs bucket
ServiceAccountId This property is required. string
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.
bucketName This property is required. String
The name of the destination GCS bucket where Temporal will send data.
gcpProjectId This property is required. String
The GCP project ID associated with the GCS bucket and service account.
region This property is required. String
The region of the gcs bucket
serviceAccountId This property is required. String
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.
bucketName This property is required. string
The name of the destination GCS bucket where Temporal will send data.
gcpProjectId This property is required. string
The GCP project ID associated with the GCS bucket and service account.
region This property is required. string
The region of the gcs bucket
serviceAccountId This property is required. string
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.
bucket_name This property is required. str
The name of the destination GCS bucket where Temporal will send data.
gcp_project_id This property is required. str
The GCP project ID associated with the GCS bucket and service account.
region This property is required. str
The region of the gcs bucket
service_account_id This property is required. str
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.
bucketName This property is required. String
The name of the destination GCS bucket where Temporal will send data.
gcpProjectId This property is required. String
The GCP project ID associated with the GCS bucket and service account.
region This property is required. String
The region of the gcs bucket
serviceAccountId This property is required. String
The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.

NamespaceExportSinkS3
, NamespaceExportSinkS3Args

AwsAccountId This property is required. string
The AWS account ID associated with the S3 bucket and the assumed role.
BucketName This property is required. string
The name of the destination S3 bucket where Temporal will send data.
KmsArn This property is required. string
The AWS Key Management Service (KMS) ARN used for encryption.
Region This property is required. string
The region where the S3 bucket is located.
RoleName This property is required. string
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
AwsAccountId This property is required. string
The AWS account ID associated with the S3 bucket and the assumed role.
BucketName This property is required. string
The name of the destination S3 bucket where Temporal will send data.
KmsArn This property is required. string
The AWS Key Management Service (KMS) ARN used for encryption.
Region This property is required. string
The region where the S3 bucket is located.
RoleName This property is required. string
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
awsAccountId This property is required. String
The AWS account ID associated with the S3 bucket and the assumed role.
bucketName This property is required. String
The name of the destination S3 bucket where Temporal will send data.
kmsArn This property is required. String
The AWS Key Management Service (KMS) ARN used for encryption.
region This property is required. String
The region where the S3 bucket is located.
roleName This property is required. String
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
awsAccountId This property is required. string
The AWS account ID associated with the S3 bucket and the assumed role.
bucketName This property is required. string
The name of the destination S3 bucket where Temporal will send data.
kmsArn This property is required. string
The AWS Key Management Service (KMS) ARN used for encryption.
region This property is required. string
The region where the S3 bucket is located.
roleName This property is required. string
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
aws_account_id This property is required. str
The AWS account ID associated with the S3 bucket and the assumed role.
bucket_name This property is required. str
The name of the destination S3 bucket where Temporal will send data.
kms_arn This property is required. str
The AWS Key Management Service (KMS) ARN used for encryption.
region This property is required. str
The region where the S3 bucket is located.
role_name This property is required. str
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
awsAccountId This property is required. String
The AWS account ID associated with the S3 bucket and the assumed role.
bucketName This property is required. String
The name of the destination S3 bucket where Temporal will send data.
kmsArn This property is required. String
The AWS Key Management Service (KMS) ARN used for encryption.
region This property is required. String
The region where the S3 bucket is located.
roleName This property is required. String
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.

NamespaceExportSinkTimeouts
, NamespaceExportSinkTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Package Details

Repository
temporalcloud temporalio/terraform-provider-temporalcloud
License
Notes
This Pulumi package is based on the temporalcloud Terraform Provider.
temporalcloud 0.7.0 published on Friday, Apr 4, 2025 by temporalio
temporalio/terraform-provider-temporalcloud