2.244.0

interface RequestParameters 🔹

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Events.AWSAPICallViaCloudTrail.RequestParameters
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotanalytics/events#AWSAPICallViaCloudTrail_RequestParameters
Javasoftware.amazon.awscdk.mixins.preview.services.iotanalytics.events.AWSAPICallViaCloudTrail.RequestParameters
Pythonaws_cdk.mixins_preview.aws_iotanalytics.events.AWSAPICallViaCloudTrail.RequestParameters
TypeScript @aws-cdk/mixins-preview » aws_iotanalytics » events » AWSAPICallViaCloudTrail » RequestParameters

Type definition for RequestParameters.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { events as iotanalytics_events } from '@aws-cdk/mixins-preview/aws-iotanalytics';
const requestParameters: iotanalytics_events.AWSAPICallViaCloudTrail.RequestParameters = {
  channelName: ['channelName'],
  channelStorage: {
    customerManagedS3: {
      bucket: ['bucket'],
      keyPrefix: ['keyPrefix'],
      roleArn: ['roleArn'],
    },
  },
  datasetName: ['datasetName'],
  datastoreIndexName: ['datastoreIndexName'],
  datastoreName: ['datastoreName'],
  datastoreStorage: {
    customerManagedS3: {
      bucket: ['bucket'],
      keyPrefix: ['keyPrefix'],
      roleArn: ['roleArn'],
    },
  },
  endTime: ['endTime'],
  loggingOptions: {
    enabled: ['enabled'],
  },
  maxMessages: ['maxMessages'],
  payloads: [{
    address: ['address'],
    bigEndian: ['bigEndian'],
    capacity: ['capacity'],
    hb: [123],
    isReadOnly: ['isReadOnly'],
    limit: ['limit'],
    mark: ['mark'],
    nativeByteOrder: ['nativeByteOrder'],
    offset: ['offset'],
    position: ['position'],
  }],
  pipelineActivity: {
    math: {
      attribute: ['attribute'],
      math: ['math'],
      name: ['name'],
    },
  },
  pipelineName: ['pipelineName'],
  queryAction: {
    sqlQuery: ['sqlQuery'],
  },
  reprocessingId: ['reprocessingId'],
  resourceArn: ['resourceArn'],
  retentionPeriod: {
    numberOfDays: ['numberOfDays'],
    unlimited: ['unlimited'],
  },
  settings: {
    timeseries: {
      dimensionAttributes: [{
        attribute: ['attribute'],
        name: ['name'],
      }],
      measureAttributes: [{
        attribute: ['attribute'],
        name: ['name'],
      }],
      timestampAttribute: ['timestampAttribute'],
    },
  },
  startTime: ['startTime'],
  tagKeys: ['tagKeys'],
  tags: [{
    key: ['key'],
    value: ['value'],
  }],
  versionId: ['versionId'],
};

Properties

NameTypeDescription
channelName?🔹string[]channelName property.
channelStorage?🔹ChannelStoragechannelStorage property.
datasetName?🔹string[]datasetName property.
datastoreIndexName?🔹string[]datastoreIndexName property.
datastoreName?🔹string[]datastoreName property.
datastoreStorage?🔹ChannelStoragedatastoreStorage property.
endTime?🔹string[]endTime property.
loggingOptions?🔹LoggingOptionsloggingOptions property.
maxMessages?🔹string[]maxMessages property.
payloads?🔹RequestParametersItem[]payloads property.
pipelineActivity?🔹PipelineActivitypipelineActivity property.
pipelineName?🔹string[]pipelineName property.
queryAction?🔹QueryActionqueryAction property.
reprocessingId?🔹string[]reprocessingId property.
resourceArn?🔹string[]resourceArn property.
retentionPeriod?🔹RetentionPeriodretentionPeriod property.
settings?🔹Settingssettings property.
startTime?🔹string[]startTime property.
tagKeys?🔹string[]tagKeys property.
tags?🔹RequestParametersItem1[]tags property.
versionId?🔹string[]versionId property.

channelName?🔹

Type: string[] (optional, default: Do not filter on this field)

channelName property.

Specify an array of string values to match this event if the actual value of channelName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

channelStorage?🔹

Type: ChannelStorage (optional, default: Do not filter on this field)

channelStorage property.

Specify an array of string values to match this event if the actual value of channelStorage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

datasetName?🔹

Type: string[] (optional, default: Do not filter on this field)

datasetName property.

Specify an array of string values to match this event if the actual value of datasetName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

datastoreIndexName?🔹

Type: string[] (optional, default: Do not filter on this field)

datastoreIndexName property.

Specify an array of string values to match this event if the actual value of datastoreIndexName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

datastoreName?🔹

Type: string[] (optional, default: Do not filter on this field)

datastoreName property.

Specify an array of string values to match this event if the actual value of datastoreName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

datastoreStorage?🔹

Type: ChannelStorage (optional, default: Do not filter on this field)

datastoreStorage property.

Specify an array of string values to match this event if the actual value of datastoreStorage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

endTime?🔹

Type: string[] (optional, default: Do not filter on this field)

endTime property.

Specify an array of string values to match this event if the actual value of endTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

loggingOptions?🔹

Type: LoggingOptions (optional, default: Do not filter on this field)

loggingOptions property.

Specify an array of string values to match this event if the actual value of loggingOptions is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

maxMessages?🔹

Type: string[] (optional, default: Do not filter on this field)

maxMessages property.

Specify an array of string values to match this event if the actual value of maxMessages is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

payloads?🔹

Type: RequestParametersItem[] (optional, default: Do not filter on this field)

payloads property.

Specify an array of string values to match this event if the actual value of payloads is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

pipelineActivity?🔹

Type: PipelineActivity (optional, default: Do not filter on this field)

pipelineActivity property.

Specify an array of string values to match this event if the actual value of pipelineActivity is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

pipelineName?🔹

Type: string[] (optional, default: Do not filter on this field)

pipelineName property.

Specify an array of string values to match this event if the actual value of pipelineName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

queryAction?🔹

Type: QueryAction (optional, default: Do not filter on this field)

queryAction property.

Specify an array of string values to match this event if the actual value of queryAction is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

reprocessingId?🔹

Type: string[] (optional, default: Do not filter on this field)

reprocessingId property.

Specify an array of string values to match this event if the actual value of reprocessingId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

resourceArn?🔹

Type: string[] (optional, default: Do not filter on this field)

resourceArn property.

Specify an array of string values to match this event if the actual value of resourceArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

retentionPeriod?🔹

Type: RetentionPeriod (optional, default: Do not filter on this field)

retentionPeriod property.

Specify an array of string values to match this event if the actual value of retentionPeriod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

settings?🔹

Type: Settings (optional, default: Do not filter on this field)

settings property.

Specify an array of string values to match this event if the actual value of settings is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

startTime?🔹

Type: string[] (optional, default: Do not filter on this field)

startTime property.

Specify an array of string values to match this event if the actual value of startTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

tagKeys?🔹

Type: string[] (optional, default: Do not filter on this field)

tagKeys property.

Specify an array of string values to match this event if the actual value of tagKeys is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

tags?🔹

Type: RequestParametersItem1[] (optional, default: Do not filter on this field)

tags property.

Specify an array of string values to match this event if the actual value of tags is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

versionId?🔹

Type: string[] (optional, default: Do not filter on this field)

versionId property.

Specify an array of string values to match this event if the actual value of versionId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

← PreviousNext →