Package com.hashicorp.cdktf.providers.google.pubsub_topic

Interface PubsubTopicIngestionDataSourceSettingsAwsKinesis

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PubsubTopicIngestionDataSourceSettingsAwsKinesis.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.496Z")
@Stability(Stable)
public interface PubsubTopicIngestionDataSourceSettingsAwsKinesis
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PubsubTopicIngestionDataSourceSettingsAwsKinesis.Builder	A builder for PubsubTopicIngestionDataSourceSettingsAwsKinesis
static class	PubsubTopicIngestionDataSourceSettingsAwsKinesis.Jsii$Proxy	An implementation for PubsubTopicIngestionDataSourceSettingsAwsKinesis

Method Summary

Modifier and Type	Method	Description
static PubsubTopicIngestionDataSourceSettingsAwsKinesis.Builder	builder()
String	getAwsRoleArn()	AWS role ARN to be used for Federated Identity authentication with Kinesis.
String	getConsumerArn()	The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode.
String	getGcpServiceAccount()	The GCP service account to be used for Federated Identity authentication with Kinesis (via a 'AssumeRoleWithWebIdentity' call for the provided role).
String	getStreamArn()	The Kinesis stream ARN to ingest data from.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsRoleArn

@Stability(Stable)
@NotNull
String getAwsRoleArn()

AWS role ARN to be used for Federated Identity authentication with Kinesis.

Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_topic#aws_role_arn PubsubTopic#aws_role_arn}

getConsumerArn

@Stability(Stable)
@NotNull
String getConsumerArn()

The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode.

The consumer must be already created and ready to be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_topic#consumer_arn PubsubTopic#consumer_arn}

getGcpServiceAccount

@Stability(Stable)
@NotNull
String getGcpServiceAccount()

The GCP service account to be used for Federated Identity authentication with Kinesis (via a 'AssumeRoleWithWebIdentity' call for the provided role).

The 'awsRoleArn' must be set up with 'accounts.google.com:sub' equals to this service account number. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

getStreamArn

@Stability(Stable)
@NotNull
String getStreamArn()

The Kinesis stream ARN to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_topic#stream_arn PubsubTopic#stream_arn}

builder

@Stability(Stable)
static PubsubTopicIngestionDataSourceSettingsAwsKinesis.Builder builder()

Returns:

a PubsubTopicIngestionDataSourceSettingsAwsKinesis.Builder of PubsubTopicIngestionDataSourceSettingsAwsKinesis