1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. logs
  5. Delivery

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.logs.Delivery

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    This structure contains information about one delivery in your account.

    A delivery is a connection between a logical delivery source and a logical delivery destination.

    For more information, see CreateDelivery.

    Create Delivery Resource

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

    Constructor syntax

    new Delivery(name: string, args: DeliveryArgs, opts?: CustomResourceOptions);
    @overload
    def Delivery(resource_name: str,
                 args: DeliveryArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Delivery(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 delivery_destination_arn: Optional[str] = None,
                 delivery_source_name: Optional[str] = None,
                 field_delimiter: Optional[str] = None,
                 record_fields: Optional[Sequence[str]] = None,
                 s3_enable_hive_compatible_path: Optional[bool] = None,
                 s3_suffix_path: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDelivery(ctx *Context, name string, args DeliveryArgs, opts ...ResourceOption) (*Delivery, error)
    public Delivery(string name, DeliveryArgs args, CustomResourceOptions? opts = null)
    public Delivery(String name, DeliveryArgs args)
    public Delivery(String name, DeliveryArgs args, CustomResourceOptions options)
    
    type: aws-native:logs:Delivery
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DeliveryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeliveryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeliveryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeliveryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeliveryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DeliveryDestinationArn string
    The ARN of the delivery destination that is associated with this delivery.
    DeliverySourceName string
    The name of the delivery source that is associated with this delivery.
    FieldDelimiter string
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    RecordFields List<string>
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    S3EnableHiveCompatiblePath bool
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    S3SuffixPath string
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags that have been assigned to this delivery.
    DeliveryDestinationArn string
    The ARN of the delivery destination that is associated with this delivery.
    DeliverySourceName string
    The name of the delivery source that is associated with this delivery.
    FieldDelimiter string
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    RecordFields []string
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    S3EnableHiveCompatiblePath bool
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    S3SuffixPath string
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    Tags TagArgs
    The tags that have been assigned to this delivery.
    deliveryDestinationArn String
    The ARN of the delivery destination that is associated with this delivery.
    deliverySourceName String
    The name of the delivery source that is associated with this delivery.
    fieldDelimiter String
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    recordFields List<String>
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    s3EnableHiveCompatiblePath Boolean
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    s3SuffixPath String
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    tags List<Tag>
    The tags that have been assigned to this delivery.
    deliveryDestinationArn string
    The ARN of the delivery destination that is associated with this delivery.
    deliverySourceName string
    The name of the delivery source that is associated with this delivery.
    fieldDelimiter string
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    recordFields string[]
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    s3EnableHiveCompatiblePath boolean
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    s3SuffixPath string
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    tags Tag[]
    The tags that have been assigned to this delivery.
    delivery_destination_arn str
    The ARN of the delivery destination that is associated with this delivery.
    delivery_source_name str
    The name of the delivery source that is associated with this delivery.
    field_delimiter str
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    record_fields Sequence[str]
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    s3_enable_hive_compatible_path bool
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    s3_suffix_path str
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    tags Sequence[TagArgs]
    The tags that have been assigned to this delivery.
    deliveryDestinationArn String
    The ARN of the delivery destination that is associated with this delivery.
    deliverySourceName String
    The name of the delivery source that is associated with this delivery.
    fieldDelimiter String
    The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
    recordFields List<String>
    The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
    s3EnableHiveCompatiblePath Boolean
    This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
    s3SuffixPath String
    This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
    tags List<Property Map>
    The tags that have been assigned to this delivery.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Delivery resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    DeliveryDestinationType string
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    DeliveryId string
    The unique ID that identifies this delivery in your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    DeliveryDestinationType string
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    DeliveryId string
    The unique ID that identifies this delivery in your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    deliveryDestinationType String
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    deliveryId String
    The unique ID that identifies this delivery in your account.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    deliveryDestinationType string
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    deliveryId string
    The unique ID that identifies this delivery in your account.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    delivery_destination_type str
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    delivery_id str
    The unique ID that identifies this delivery in your account.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that uniquely identifies this delivery.
    deliveryDestinationType String
    Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
    deliveryId String
    The unique ID that identifies this delivery in your account.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi