Class CfnDelivery

This structure contains information about one delivery in your account.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDelivery

Implements

IInspectable

IDeliveryRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Logs

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDelivery : CfnResource, IInspectable, IDeliveryRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDelivery Inherits CfnResource Implements IInspectable, IDeliveryRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Logs;

             var cfnDelivery = new CfnDelivery(this, "MyCfnDelivery", new CfnDeliveryProps {
                 DeliveryDestinationArn = "deliveryDestinationArn",
                 DeliverySourceName = "deliverySourceName",

                 // the properties below are optional
                 FieldDelimiter = "fieldDelimiter",
                 RecordFields = new [] { "recordFields" },
                 S3EnableHiveCompatiblePath = false,
                 S3SuffixPath = "s3SuffixPath",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDelivery(Construct, string, ICfnDeliveryProps)

Create a new AWS::Logs::Delivery.

Properties

AttrArn	The Amazon Resource Name (ARN) that uniquely identifies this delivery.
AttrDeliveryDestinationType	Displays whether the delivery destination associated with this delivery is CloudWatch Logs , Amazon S3 , or Firehose .
AttrDeliveryId	The unique ID that identifies this delivery in your account.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	This structure contains information about one delivery in your account.
DeliveryDestinationArn	The ARN of the delivery destination that is associated with this delivery.
DeliveryRef	A reference to a Delivery resource.
DeliverySourceName	The name of the delivery source that is associated with this delivery.
FieldDelimiter	The field delimiter that is used between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
RecordFields	The list of record fields to be delivered to the destination, in order.
S3EnableHiveCompatiblePath	Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
S3SuffixPath	Use this to reconfigure the S3 object prefix to contain either static or variable sections.
Tags	An array of key-value pairs to apply to the delivery.

Methods

ArnForDelivery(IDeliveryRef)	This structure contains information about one delivery in your account.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDelivery(object)	Checks whether the given object is a CfnDelivery.
RenderProperties(IDictionary<string, object>)	This structure contains information about one delivery in your account.

Constructors

CfnDelivery(Construct, string, ICfnDeliveryProps)

Create a new AWS::Logs::Delivery.

public CfnDelivery(Construct scope, string id, ICfnDeliveryProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDeliveryProps

Resource properties.

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) that uniquely identifies this delivery.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrDeliveryDestinationType

Displays whether the delivery destination associated with this delivery is CloudWatch Logs , Amazon S3 , or Firehose .

public virtual string AttrDeliveryDestinationType { get; }

Property Value

string

Remarks

CloudformationAttribute: DeliveryDestinationType

AttrDeliveryId

The unique ID that identifies this delivery in your account.

public virtual string AttrDeliveryId { get; }

Property Value

string

Remarks

CloudformationAttribute: DeliveryId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

CfnProperties

This structure contains information about one delivery in your account.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

DeliveryDestinationArn

The ARN of the delivery destination that is associated with this delivery.

public virtual string DeliveryDestinationArn { get; set; }

Property Value

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

DeliveryRef

A reference to a Delivery resource.

public virtual IDeliveryReference DeliveryRef { get; }

Property Value

IDeliveryReference

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

DeliverySourceName

The name of the delivery source that is associated with this delivery.

public virtual string DeliverySourceName { get; set; }

Property Value

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

FieldDelimiter

The field delimiter that is used between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.

public virtual string? FieldDelimiter { get; set; }

Property Value

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

RecordFields

The list of record fields to be delivered to the destination, in order.

public virtual string[]? RecordFields { get; set; }

Property Value

string[]

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

S3EnableHiveCompatiblePath

Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

public virtual object? S3EnableHiveCompatiblePath { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

S3SuffixPath

Use this to reconfigure the S3 object prefix to contain either static or variable sections.

public virtual string? S3SuffixPath { get; set; }

Property Value

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Tags

An array of key-value pairs to apply to the delivery.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Methods

ArnForDelivery(IDeliveryRef)

This structure contains information about one delivery in your account.

public static string ArnForDelivery(IDeliveryRef resource)

Parameters

resource IDeliveryRef

Returns

string

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Logs;

             var cfnDelivery = new CfnDelivery(this, "MyCfnDelivery", new CfnDeliveryProps {
                 DeliveryDestinationArn = "deliveryDestinationArn",
                 DeliverySourceName = "deliverySourceName",

                 // the properties below are optional
                 FieldDelimiter = "fieldDelimiter",
                 RecordFields = new [] { "recordFields" },
                 S3EnableHiveCompatiblePath = false,
                 S3SuffixPath = "s3SuffixPath",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

IsCfnDelivery(object)

Checks whether the given object is a CfnDelivery.

public static bool IsCfnDelivery(object x)

Parameters

x object

Returns

bool

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This structure contains information about one delivery in your account.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

CloudformationResource: AWS::Logs::Delivery

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeliveryRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2