Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iotanalytics
  5. getDatastore

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotanalytics.getDatastore

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoTAnalytics::Datastore

    Using getDatastore

    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 getDatastore(args: GetDatastoreArgs, opts?: InvokeOptions): Promise<GetDatastoreResult>
function getDatastoreOutput(args: GetDatastoreOutputArgs, opts?: InvokeOptions): Output<GetDatastoreResult>
    def get_datastore(datastore_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDatastoreResult
def get_datastore_output(datastore_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDatastoreResult]
    func LookupDatastore(ctx *Context, args *LookupDatastoreArgs, opts ...InvokeOption) (*LookupDatastoreResult, error)
func LookupDatastoreOutput(ctx *Context, args *LookupDatastoreOutputArgs, opts ...InvokeOption) LookupDatastoreResultOutput

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

    public static class GetDatastore 
{
    public static Task<GetDatastoreResult> InvokeAsync(GetDatastoreArgs args, InvokeOptions? opts = null)
    public static Output<GetDatastoreResult> Invoke(GetDatastoreInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatastoreResult> getDatastore(GetDatastoreArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:iotanalytics:getDatastore
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatastoreName string
    The name of the data store.
    DatastoreName string
    The name of the data store.
    datastoreName String
    The name of the data store.
    datastoreName string
    The name of the data store.
    datastore_name str
    The name of the data store.
    datastoreName String
    The name of the data store.

    getDatastore Result

    The following output properties are available:

    DatastorePartitions Pulumi.AwsNative.IoTAnalytics.Outputs.DatastorePartitions
    Information about the partition dimensions in a data store.
    DatastoreStorage Pulumi.AwsNative.IoTAnalytics.Outputs.DatastoreStorage
    Where data store data is stored.
    FileFormatConfiguration Pulumi.AwsNative.IoTAnalytics.Outputs.DatastoreFileFormatConfiguration

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    Id string
    RetentionPeriod Pulumi.AwsNative.IoTAnalytics.Outputs.DatastoreRetentionPeriod
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    DatastorePartitions DatastorePartitions
    Information about the partition dimensions in a data store.
    DatastoreStorage DatastoreStorage
    Where data store data is stored.
    FileFormatConfiguration DatastoreFileFormatConfiguration

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    Id string
    RetentionPeriod DatastoreRetentionPeriod
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    Tags Tag

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    datastorePartitions DatastorePartitions
    Information about the partition dimensions in a data store.
    datastoreStorage DatastoreStorage
    Where data store data is stored.
    fileFormatConfiguration DatastoreFileFormatConfiguration

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    id String
    retentionPeriod DatastoreRetentionPeriod
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    tags List<Tag>

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    datastorePartitions DatastorePartitions
    Information about the partition dimensions in a data store.
    datastoreStorage DatastoreStorage
    Where data store data is stored.
    fileFormatConfiguration DatastoreFileFormatConfiguration

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    id string
    retentionPeriod DatastoreRetentionPeriod
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    tags Tag[]

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    datastore_partitions DatastorePartitions
    Information about the partition dimensions in a data store.
    datastore_storage DatastoreStorage
    Where data store data is stored.
    file_format_configuration DatastoreFileFormatConfiguration

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    id str
    retention_period DatastoreRetentionPeriod
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    tags Sequence[root_Tag]

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    datastorePartitions Property Map
    Information about the partition dimensions in a data store.
    datastoreStorage Property Map
    Where data store data is stored.
    fileFormatConfiguration Property Map

    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

    The default file format is JSON. You can specify only one format.

    You can't change the file format after you create the data store.

    id String
    retentionPeriod Property Map
    How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
    tags List<Property Map>

    Metadata which can be used to manage the data store.

    For more information, see Tag .

    Supporting Types

    DatastoreColumn

    Name string
    The name of the column.
    Type string
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
    Name string
    The name of the column.
    Type string
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
    name String
    The name of the column.
    type String
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
    name string
    The name of the column.
    type string
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
    name str
    The name of the column.
    type str
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
    name String
    The name of the column.
    type String
    The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .

    DatastoreCustomerManagedS3

    Bucket string
    The name of the Amazon S3 bucket where your data is stored.
    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    KeyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    Bucket string
    The name of the Amazon S3 bucket where your data is stored.
    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    KeyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket String
    The name of the Amazon S3 bucket where your data is stored.
    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    keyPrefix String
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket string
    The name of the Amazon S3 bucket where your data is stored.
    roleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    keyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket str
    The name of the Amazon S3 bucket where your data is stored.
    role_arn str
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    key_prefix str
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket String
    The name of the Amazon S3 bucket where your data is stored.
    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
    keyPrefix String
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

    DatastoreCustomerManagedS3Storage

    Bucket string
    The name of the Amazon S3 bucket where your data is stored.
    KeyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    Bucket string
    The name of the Amazon S3 bucket where your data is stored.
    KeyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket String
    The name of the Amazon S3 bucket where your data is stored.
    keyPrefix String
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket string
    The name of the Amazon S3 bucket where your data is stored.
    keyPrefix string
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket str
    The name of the Amazon S3 bucket where your data is stored.
    key_prefix str
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
    bucket String
    The name of the Amazon S3 bucket where your data is stored.
    keyPrefix String
    (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

    DatastoreFileFormatConfiguration

    JsonConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreJsonConfiguration
    Contains the configuration information of the JSON format.
    ParquetConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreParquetConfiguration
    Contains the configuration information of the Parquet format.
    JsonConfiguration DatastoreJsonConfiguration
    Contains the configuration information of the JSON format.
    ParquetConfiguration DatastoreParquetConfiguration
    Contains the configuration information of the Parquet format.
    jsonConfiguration DatastoreJsonConfiguration
    Contains the configuration information of the JSON format.
    parquetConfiguration DatastoreParquetConfiguration
    Contains the configuration information of the Parquet format.
    jsonConfiguration DatastoreJsonConfiguration
    Contains the configuration information of the JSON format.
    parquetConfiguration DatastoreParquetConfiguration
    Contains the configuration information of the Parquet format.
    json_configuration DatastoreJsonConfiguration
    Contains the configuration information of the JSON format.
    parquet_configuration DatastoreParquetConfiguration
    Contains the configuration information of the Parquet format.
    jsonConfiguration Property Map
    Contains the configuration information of the JSON format.
    parquetConfiguration Property Map
    Contains the configuration information of the Parquet format.

    DatastoreIotSiteWiseMultiLayerStorage

    CustomerManagedS3Storage Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreCustomerManagedS3Storage
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
    CustomerManagedS3Storage DatastoreCustomerManagedS3Storage
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
    customerManagedS3Storage DatastoreCustomerManagedS3Storage
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
    customerManagedS3Storage DatastoreCustomerManagedS3Storage
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
    customer_managed_s3_storage DatastoreCustomerManagedS3Storage
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
    customerManagedS3Storage Property Map
    Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.

    DatastoreParquetConfiguration

    SchemaDefinition DatastoreSchemaDefinition
    Information needed to define a schema.
    schemaDefinition DatastoreSchemaDefinition
    Information needed to define a schema.
    schemaDefinition DatastoreSchemaDefinition
    Information needed to define a schema.
    schema_definition DatastoreSchemaDefinition
    Information needed to define a schema.
    schemaDefinition Property Map
    Information needed to define a schema.

    DatastorePartition

    Partition Pulumi.AwsNative.IoTAnalytics.Inputs.Partition
    A partition dimension defined by an attribute.
    TimestampPartition Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreTimestampPartition
    A partition dimension defined by a timestamp attribute.
    Partition Partition
    A partition dimension defined by an attribute.
    TimestampPartition DatastoreTimestampPartition
    A partition dimension defined by a timestamp attribute.
    partition Partition
    A partition dimension defined by an attribute.
    timestampPartition DatastoreTimestampPartition
    A partition dimension defined by a timestamp attribute.
    partition Partition
    A partition dimension defined by an attribute.
    timestampPartition DatastoreTimestampPartition
    A partition dimension defined by a timestamp attribute.
    partition Partition
    A partition dimension defined by an attribute.
    timestamp_partition DatastoreTimestampPartition
    A partition dimension defined by a timestamp attribute.
    partition Property Map
    A partition dimension defined by an attribute.
    timestampPartition Property Map
    A partition dimension defined by a timestamp attribute.

    DatastorePartitions

    Partitions List<Pulumi.AwsNative.IoTAnalytics.Inputs.DatastorePartition>
    A list of partition dimensions in a data store.
    Partitions []DatastorePartition
    A list of partition dimensions in a data store.
    partitions List<DatastorePartition>
    A list of partition dimensions in a data store.
    partitions DatastorePartition[]
    A list of partition dimensions in a data store.
    partitions Sequence[DatastorePartition]
    A list of partition dimensions in a data store.
    partitions List<Property Map>
    A list of partition dimensions in a data store.

    DatastoreRetentionPeriod

    NumberOfDays int
    The number of days that message data is kept. The unlimited parameter must be false.
    Unlimited bool
    If true, message data is kept indefinitely.
    NumberOfDays int
    The number of days that message data is kept. The unlimited parameter must be false.
    Unlimited bool
    If true, message data is kept indefinitely.
    numberOfDays Integer
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited Boolean
    If true, message data is kept indefinitely.
    numberOfDays number
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited boolean
    If true, message data is kept indefinitely.
    number_of_days int
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited bool
    If true, message data is kept indefinitely.
    numberOfDays Number
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited Boolean
    If true, message data is kept indefinitely.

    DatastoreSchemaDefinition

    Columns List<Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreColumn>

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    Columns []DatastoreColumn

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    columns List<DatastoreColumn>

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    columns DatastoreColumn[]

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    columns Sequence[DatastoreColumn]

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    columns List<Property Map>

    Specifies one or more columns that store your data.

    Each schema can have up to 100 columns. Each column can have up to 100 nested types.

    DatastoreStorage

    CustomerManagedS3 Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreCustomerManagedS3
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    IotSiteWiseMultiLayerStorage Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreIotSiteWiseMultiLayerStorage
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    ServiceManagedS3 Pulumi.AwsNative.IoTAnalytics.Inputs.DatastoreServiceManagedS3
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    CustomerManagedS3 DatastoreCustomerManagedS3
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    IotSiteWiseMultiLayerStorage DatastoreIotSiteWiseMultiLayerStorage
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    ServiceManagedS3 DatastoreServiceManagedS3
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    customerManagedS3 DatastoreCustomerManagedS3
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    iotSiteWiseMultiLayerStorage DatastoreIotSiteWiseMultiLayerStorage
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    serviceManagedS3 DatastoreServiceManagedS3
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    customerManagedS3 DatastoreCustomerManagedS3
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    iotSiteWiseMultiLayerStorage DatastoreIotSiteWiseMultiLayerStorage
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    serviceManagedS3 DatastoreServiceManagedS3
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    customer_managed_s3 DatastoreCustomerManagedS3
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    iot_site_wise_multi_layer_storage DatastoreIotSiteWiseMultiLayerStorage
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    service_managed_s3 DatastoreServiceManagedS3
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    customerManagedS3 Property Map
    Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
    iotSiteWiseMultiLayerStorage Property Map
    Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
    serviceManagedS3 Property Map
    Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

    DatastoreTimestampPartition

    AttributeName string
    The attribute name of the partition defined by a timestamp.
    TimestampFormat string
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
    AttributeName string
    The attribute name of the partition defined by a timestamp.
    TimestampFormat string
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
    attributeName String
    The attribute name of the partition defined by a timestamp.
    timestampFormat String
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
    attributeName string
    The attribute name of the partition defined by a timestamp.
    timestampFormat string
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
    attribute_name str
    The attribute name of the partition defined by a timestamp.
    timestamp_format str
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
    attributeName String
    The attribute name of the partition defined by a timestamp.
    timestampFormat String
    The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

    Partition

    AttributeName string
    The name of the attribute that defines a partition dimension.
    AttributeName string
    The name of the attribute that defines a partition dimension.
    attributeName String
    The name of the attribute that defines a partition dimension.
    attributeName string
    The name of the attribute that defines a partition dimension.
    attribute_name str
    The name of the attribute that defines a partition dimension.
    attributeName String
    The name of the attribute that defines a partition dimension.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native