Class CfnDelivery
This structure contains information about one delivery in your account.
Inherited Members
Namespace: Amazon.CDK.AWS.Logs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDelivery : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDelivery
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDelivery(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDelivery(Construct, String, ICfnDeliveryProps) |
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. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeliveryDestinationArn | The ARN of the delivery destination that is associated with this delivery. |
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 |
RecordFields | The record fields used in this delivery. |
S3EnableHiveCompatiblePath | This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive. |
S3SuffixPath | This string allows re-configuring the S3 object prefix to contain either static or variable sections. |
Tags | The tags that have been assigned to this delivery. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDelivery(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDelivery(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDelivery(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDelivery(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDelivery(Construct, String, ICfnDeliveryProps)
public CfnDelivery(Construct scope, string id, ICfnDeliveryProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeliveryProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) that uniquely identifies this delivery.
public virtual string AttrArn { get; }
Property Value
System.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
System.String
Remarks
CloudformationAttribute: DeliveryDestinationType
AttrDeliveryId
The unique ID that identifies this delivery in your account.
public virtual string AttrDeliveryId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DeliveryId
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeliveryDestinationArn
The ARN of the delivery destination that is associated with this delivery.
public virtual string DeliveryDestinationArn { get; set; }
Property Value
System.String
DeliverySourceName
The name of the delivery source that is associated with this delivery.
public virtual string DeliverySourceName { get; set; }
Property Value
System.String
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
System.String
RecordFields
The record fields used in this delivery.
public virtual string[] RecordFields { get; set; }
Property Value
System.String[]
S3EnableHiveCompatiblePath
This parameter causes 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
System.Object
S3SuffixPath
This string allows re-configuring the S3 object prefix to contain either static or variable sections.
public virtual string S3SuffixPath { get; set; }
Property Value
System.String
Tags
The tags that have been assigned to this delivery.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>