Class CfnLogDeliveryConfiguration

Sets up or modifies the logging configuration of a user pool.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnLogDeliveryConfiguration
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLogDeliveryConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnLogDeliveryConfiguration
    Inherits CfnResource
    Implements IInspectable
Remarks

User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool logs .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html

CloudformationResource: AWS::Cognito::LogDeliveryConfiguration

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.Cognito;

var cfnLogDeliveryConfiguration = new CfnLogDeliveryConfiguration(this, "MyCfnLogDeliveryConfiguration", new CfnLogDeliveryConfigurationProps {
    UserPoolId = "userPoolId",

    // the properties below are optional
    LogConfigurations = new [] { new LogConfigurationProperty {
        CloudWatchLogsConfiguration = new CloudWatchLogsConfigurationProperty {
            LogGroupArn = "logGroupArn"
        },
        EventSource = "eventSource",
        FirehoseConfiguration = new FirehoseConfigurationProperty {
            StreamArn = "streamArn"
        },
        LogLevel = "logLevel",
        S3Configuration = new S3ConfigurationProperty {
            BucketArn = "bucketArn"
        }
    } }
});

Synopsis

Constructors

CfnLogDeliveryConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnLogDeliveryConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnLogDeliveryConfiguration(Construct, String, ICfnLogDeliveryConfigurationProps)

Properties

AttrId

A user pool ID, for example us-east-1_EXAMPLE .
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
LogConfigurations

A logging destination of a user pool.
UserPoolId

The ID of the user pool where you configured logging.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnLogDeliveryConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnLogDeliveryConfiguration(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnLogDeliveryConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnLogDeliveryConfiguration(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnLogDeliveryConfiguration(Construct, String, ICfnLogDeliveryConfigurationProps)

public CfnLogDeliveryConfiguration(Construct scope, string id, ICfnLogDeliveryConfigurationProps 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 ICfnLogDeliveryConfigurationProps

Resource properties.

Properties

AttrId

A user pool ID, for example us-east-1_EXAMPLE .

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

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

LogConfigurations

A logging destination of a user pool.

public virtual object LogConfigurations { get; set; }
Property Value

System.Object

UserPoolId

The ID of the user pool where you configured logging.

public virtual string UserPoolId { get; set; }
Property Value

System.String

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>

Overrides

Implements