/AWS1/CL_CWLDELIVERYSOURCE¶
This structure contains information about one delivery source in your account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
-
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_name TYPE /AWS1/CWLDELIVERYSOURCENAME /AWS1/CWLDELIVERYSOURCENAME¶
The unique name of the delivery source.
iv_arn TYPE /AWS1/CWLARN /AWS1/CWLARN¶
The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
it_resourcearns TYPE /AWS1/CL_CWLRESOURCEARNS_W=>TT_RESOURCEARNS TT_RESOURCEARNS¶
This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
iv_service TYPE /AWS1/CWLSERVICE /AWS1/CWLSERVICE¶
The Amazon Web Services service that is sending logs.
iv_logtype TYPE /AWS1/CWLLOGTYPE /AWS1/CWLLOGTYPE¶
The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.
it_tags TYPE /AWS1/CL_CWLTAGS_W=>TT_TAGS TT_TAGS¶
The tags that have been assigned to this delivery source.
it_deliverysourceconf TYPE /AWS1/CL_CWLDLVRYSOURCECONF_W=>TT_DELIVERYSOURCECONFIGURATION TT_DELIVERYSOURCECONFIGURATION¶
The map of key-value pairs that configure the delivery source.
iv_status TYPE /AWS1/CWLDELIVERYSOURCESTATUS /AWS1/CWLDELIVERYSOURCESTATUS¶
The status of the delivery source. A delivery source can have the status
ACTIVEorINACTIVE. Note: This value is defined for selective log types.
iv_statusreason TYPE /AWS1/CWLDLVRYSOURCESTATUSRSN /AWS1/CWLDLVRYSOURCESTATUSRSN¶
The reason for the status of the delivery source. A status reason of
RESOURCE_DELETEDindicates that the resource associated with the delivery source has been deleted. Note: This value is defined for selective log types.
Queryable Attributes¶
name¶
The unique name of the delivery source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
arn¶
The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
resourceArns¶
This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARNS() |
Getter for RESOURCEARNS, with configurable default |
ASK_RESOURCEARNS() |
Getter for RESOURCEARNS w/ exceptions if field has no value |
HAS_RESOURCEARNS() |
Determine if RESOURCEARNS has a value |
service¶
The Amazon Web Services service that is sending logs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICE() |
Getter for SERVICE, with configurable default |
ASK_SERVICE() |
Getter for SERVICE w/ exceptions if field has no value |
HAS_SERVICE() |
Determine if SERVICE has a value |
logType¶
The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGTYPE() |
Getter for LOGTYPE, with configurable default |
ASK_LOGTYPE() |
Getter for LOGTYPE w/ exceptions if field has no value |
HAS_LOGTYPE() |
Determine if LOGTYPE has a value |
tags¶
The tags that have been assigned to this delivery source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
deliverySourceConfiguration¶
The map of key-value pairs that configure the delivery source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSOURCECONF() |
Getter for DELIVERYSOURCECONFIGURATION, with configurable de |
ASK_DELIVERYSOURCECONF() |
Getter for DELIVERYSOURCECONFIGURATION w/ exceptions if fiel |
HAS_DELIVERYSOURCECONF() |
Determine if DELIVERYSOURCECONFIGURATION has a value |
status¶
The status of the delivery source. A delivery source can have the status
ACTIVEorINACTIVE. Note: This value is defined for selective log types.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
statusReason¶
The reason for the status of the delivery source. A status reason of
RESOURCE_DELETEDindicates that the resource associated with the delivery source has been deleted. Note: This value is defined for selective log types.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_DELIVERYSOURCES¶
TYPES TT_DELIVERYSOURCES TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWLDELIVERYSOURCE WITH DEFAULT KEY
.