aws-native logo
AWS Native v0.55.0, Mar 28 23

aws-native.kinesisfirehose.getDeliveryStream

Resource Type definition for AWS::KinesisFirehose::DeliveryStream

Using getDeliveryStream

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeliveryStream(args: GetDeliveryStreamArgs, opts?: InvokeOptions): Promise<GetDeliveryStreamResult>
function getDeliveryStreamOutput(args: GetDeliveryStreamOutputArgs, opts?: InvokeOptions): Output<GetDeliveryStreamResult>
def get_delivery_stream(delivery_stream_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDeliveryStreamResult
def get_delivery_stream_output(delivery_stream_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDeliveryStreamResult]
func LookupDeliveryStream(ctx *Context, args *LookupDeliveryStreamArgs, opts ...InvokeOption) (*LookupDeliveryStreamResult, error)
func LookupDeliveryStreamOutput(ctx *Context, args *LookupDeliveryStreamOutputArgs, opts ...InvokeOption) LookupDeliveryStreamResultOutput

> Note: This function is named LookupDeliveryStream in the Go SDK.

public static class GetDeliveryStream 
{
    public static Task<GetDeliveryStreamResult> InvokeAsync(GetDeliveryStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetDeliveryStreamResult> Invoke(GetDeliveryStreamInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeliveryStreamResult> getDeliveryStream(GetDeliveryStreamArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:kinesisfirehose:getDeliveryStream
  arguments:
    # arguments dictionary

The following arguments are supported:

getDeliveryStream Result

The following output properties are available:

AmazonOpenSearchServerlessDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration
AmazonopensearchserviceDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamAmazonopensearchserviceDestinationConfiguration
Arn string
DeliveryStreamEncryptionConfigurationInput Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamEncryptionConfigurationInput
ElasticsearchDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamElasticsearchDestinationConfiguration
ExtendedS3DestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamExtendedS3DestinationConfiguration
HttpEndpointDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamHttpEndpointDestinationConfiguration
RedshiftDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamRedshiftDestinationConfiguration
S3DestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamS3DestinationConfiguration
SplunkDestinationConfiguration Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamSplunkDestinationConfiguration
Tags List<Pulumi.AwsNative.KinesisFirehose.Outputs.DeliveryStreamTag>
AmazonOpenSearchServerlessDestinationConfiguration DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration
AmazonopensearchserviceDestinationConfiguration DeliveryStreamAmazonopensearchserviceDestinationConfiguration
Arn string
DeliveryStreamEncryptionConfigurationInput DeliveryStreamEncryptionConfigurationInputType
ElasticsearchDestinationConfiguration DeliveryStreamElasticsearchDestinationConfiguration
ExtendedS3DestinationConfiguration DeliveryStreamExtendedS3DestinationConfiguration
HttpEndpointDestinationConfiguration DeliveryStreamHttpEndpointDestinationConfiguration
RedshiftDestinationConfiguration DeliveryStreamRedshiftDestinationConfiguration
S3DestinationConfiguration DeliveryStreamS3DestinationConfiguration
SplunkDestinationConfiguration DeliveryStreamSplunkDestinationConfiguration
Tags []DeliveryStreamTag
amazonOpenSearchServerlessDestinationConfiguration DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration
amazonopensearchserviceDestinationConfiguration DeliveryStreamAmazonopensearchserviceDestinationConfiguration
arn String
deliveryStreamEncryptionConfigurationInput DeliveryStreamEncryptionConfigurationInput
elasticsearchDestinationConfiguration DeliveryStreamElasticsearchDestinationConfiguration
extendedS3DestinationConfiguration DeliveryStreamExtendedS3DestinationConfiguration
httpEndpointDestinationConfiguration DeliveryStreamHttpEndpointDestinationConfiguration
redshiftDestinationConfiguration DeliveryStreamRedshiftDestinationConfiguration
s3DestinationConfiguration DeliveryStreamS3DestinationConfiguration
splunkDestinationConfiguration DeliveryStreamSplunkDestinationConfiguration
tags List<DeliveryStreamTag>
amazonOpenSearchServerlessDestinationConfiguration DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration
amazonopensearchserviceDestinationConfiguration DeliveryStreamAmazonopensearchserviceDestinationConfiguration
arn string
deliveryStreamEncryptionConfigurationInput DeliveryStreamEncryptionConfigurationInput
elasticsearchDestinationConfiguration DeliveryStreamElasticsearchDestinationConfiguration
extendedS3DestinationConfiguration DeliveryStreamExtendedS3DestinationConfiguration
httpEndpointDestinationConfiguration DeliveryStreamHttpEndpointDestinationConfiguration
redshiftDestinationConfiguration DeliveryStreamRedshiftDestinationConfiguration
s3DestinationConfiguration DeliveryStreamS3DestinationConfiguration
splunkDestinationConfiguration DeliveryStreamSplunkDestinationConfiguration
tags DeliveryStreamTag[]
amazon_open_search_serverless_destination_configuration DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration
amazonopensearchservice_destination_configuration DeliveryStreamAmazonopensearchserviceDestinationConfiguration
arn str
delivery_stream_encryption_configuration_input DeliveryStreamEncryptionConfigurationInput
elasticsearch_destination_configuration DeliveryStreamElasticsearchDestinationConfiguration
extended_s3_destination_configuration DeliveryStreamExtendedS3DestinationConfiguration
http_endpoint_destination_configuration DeliveryStreamHttpEndpointDestinationConfiguration
redshift_destination_configuration DeliveryStreamRedshiftDestinationConfiguration
s3_destination_configuration DeliveryStreamS3DestinationConfiguration
splunk_destination_configuration DeliveryStreamSplunkDestinationConfiguration
tags Sequence[DeliveryStreamTag]

Supporting Types

DeliveryStreamAmazonOpenSearchServerlessBufferingHints

DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration

DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode

DeliveryStreamAmazonOpenSearchServerlessRetryOptions

DeliveryStreamAmazonopensearchserviceBufferingHints

DeliveryStreamAmazonopensearchserviceDestinationConfiguration

IndexName string
RoleARN string
S3Configuration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamS3DestinationConfiguration
BufferingHints Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamAmazonopensearchserviceBufferingHints
CloudWatchLoggingOptions Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamCloudWatchLoggingOptions
ClusterEndpoint string
DomainARN string
IndexRotationPeriod Pulumi.AwsNative.KinesisFirehose.DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod
ProcessingConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamProcessingConfiguration
RetryOptions Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamAmazonopensearchserviceRetryOptions
S3BackupMode Pulumi.AwsNative.KinesisFirehose.DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode
TypeName string
VpcConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamVpcConfiguration

DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod

DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode

DeliveryStreamAmazonopensearchserviceRetryOptions

DeliveryStreamBufferingHints

DeliveryStreamCloudWatchLoggingOptions

enabled Boolean
logGroupName String
logStreamName String
enabled boolean
logGroupName string
logStreamName string
enabled Boolean
logGroupName String
logStreamName String

DeliveryStreamCopyCommand

DeliveryStreamDataFormatConversionConfiguration

DeliveryStreamDeserializer

DeliveryStreamDynamicPartitioningConfiguration

DeliveryStreamElasticsearchBufferingHints

DeliveryStreamElasticsearchDestinationConfiguration

IndexName string
RoleARN string
S3Configuration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamS3DestinationConfiguration
BufferingHints Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamElasticsearchBufferingHints
CloudWatchLoggingOptions Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamCloudWatchLoggingOptions
ClusterEndpoint string
DomainARN string
IndexRotationPeriod Pulumi.AwsNative.KinesisFirehose.DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod
ProcessingConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamProcessingConfiguration
RetryOptions Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamElasticsearchRetryOptions
S3BackupMode Pulumi.AwsNative.KinesisFirehose.DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode
TypeName string
VpcConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamVpcConfiguration

DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod

DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode

DeliveryStreamElasticsearchRetryOptions

DeliveryStreamEncryptionConfiguration

DeliveryStreamEncryptionConfigurationInput

DeliveryStreamEncryptionConfigurationInputKeyType

DeliveryStreamEncryptionConfigurationNoEncryptionConfig

DeliveryStreamExtendedS3DestinationConfiguration

BucketARN string
RoleARN string
BufferingHints Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamBufferingHints
CloudWatchLoggingOptions Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamCloudWatchLoggingOptions
CompressionFormat Pulumi.AwsNative.KinesisFirehose.DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat
DataFormatConversionConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamDataFormatConversionConfiguration
DynamicPartitioningConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamDynamicPartitioningConfiguration
EncryptionConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamEncryptionConfiguration
ErrorOutputPrefix string
Prefix string
ProcessingConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamProcessingConfiguration
S3BackupConfiguration Pulumi.AwsNative.KinesisFirehose.Inputs.DeliveryStreamS3DestinationConfiguration
S3BackupMode Pulumi.AwsNative.KinesisFirehose.DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode

DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat

DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode

DeliveryStreamHiveJsonSerDe

TimestampFormats List<string>
timestampFormats List<String>
timestamp_formats Sequence[str]
timestampFormats List<String>

DeliveryStreamHttpEndpointCommonAttribute

DeliveryStreamHttpEndpointConfiguration

Url string
AccessKey string
Name string
Url string
AccessKey string
Name string
url String
accessKey String
name String
url string
accessKey string
name string
url str
access_key str
name str
url String
accessKey String
name String

DeliveryStreamHttpEndpointDestinationConfiguration

DeliveryStreamHttpEndpointRequestConfiguration

DeliveryStreamHttpEndpointRequestConfigurationContentEncoding

DeliveryStreamInputFormatConfiguration

DeliveryStreamKMSEncryptionConfig

DeliveryStreamOpenXJsonSerDe

DeliveryStreamOrcSerDe

DeliveryStreamOutputFormatConfiguration

DeliveryStreamParquetSerDe

DeliveryStreamProcessingConfiguration

DeliveryStreamProcessor

DeliveryStreamProcessorParameter

DeliveryStreamProcessorType

DeliveryStreamRedshiftDestinationConfiguration

DeliveryStreamRedshiftDestinationConfigurationS3BackupMode

DeliveryStreamRedshiftRetryOptions

DeliveryStreamRetryOptions

DeliveryStreamS3DestinationConfiguration

DeliveryStreamS3DestinationConfigurationCompressionFormat

DeliveryStreamSchemaConfiguration

CatalogId string
DatabaseName string
Region string
RoleARN string
TableName string
VersionId string
CatalogId string
DatabaseName string
Region string
RoleARN string
TableName string
VersionId string
catalogId String
databaseName String
region String
roleARN String
tableName String
versionId String
catalogId string
databaseName string
region string
roleARN string
tableName string
versionId string
catalogId String
databaseName String
region String
roleARN String
tableName String
versionId String

DeliveryStreamSerializer

DeliveryStreamSplunkDestinationConfiguration

DeliveryStreamSplunkDestinationConfigurationHECEndpointType

DeliveryStreamSplunkRetryOptions

DeliveryStreamTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

DeliveryStreamVpcConfiguration

RoleARN string
SecurityGroupIds List<string>
SubnetIds List<string>
RoleARN string
SecurityGroupIds []string
SubnetIds []string
roleARN String
securityGroupIds List<String>
subnetIds List<String>
roleARN string
securityGroupIds string[]
subnetIds string[]
role_arn str
security_group_ids Sequence[str]
subnet_ids Sequence[str]
roleARN String
securityGroupIds List<String>
subnetIds List<String>

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0