Class CfnLogDeliveryConfiguration

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnLogDeliveryConfiguration
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLogDeliveryConfiguration : CfnResource, IInspectable, ILogDeliveryConfigurationRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnLogDeliveryConfiguration Inherits CfnResource Implements IInspectable, ILogDeliveryConfigurationRef, IConstruct, IDependable, IEnvironmentAware
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(Construct, string, ICfnLogDeliveryConfigurationProps)

Create a new AWS::Cognito::LogDeliveryConfiguration.

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

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

A logging destination of a user pool.
LogDeliveryConfigurationRef

A reference to a LogDeliveryConfiguration resource.
UserPoolId

The ID of the user pool where you configured logging.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnLogDeliveryConfiguration(object)

Checks whether the given object is a CfnLogDeliveryConfiguration.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnLogDeliveryConfiguration(Construct, string, ICfnLogDeliveryConfigurationProps)

Create a new AWS::Cognito::LogDeliveryConfiguration.

public CfnLogDeliveryConfiguration(Construct scope, string id, ICfnLogDeliveryConfigurationProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnLogDeliveryConfigurationProps

Resource properties.

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

Properties

AttrId

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

public virtual string AttrId { get; }
Property Value

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

string

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

CfnProperties

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

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

IDictionary<string, object>

Overrides
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

LogConfigurations

A logging destination of a user pool.

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

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnLogDeliveryConfiguration.ILogConfigurationProperty)[]

LogDeliveryConfigurationRef

A reference to a LogDeliveryConfiguration resource.

public virtual ILogDeliveryConfigurationReference LogDeliveryConfigurationRef { get; }
Property Value

ILogDeliveryConfigurationReference

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

UserPoolId

The ID of the user pool where you configured logging.

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

string

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

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.

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

IsCfnLogDeliveryConfiguration(object)

Checks whether the given object is a CfnLogDeliveryConfiguration.

public static bool IsCfnLogDeliveryConfiguration(object x)
Parameters
x object
Returns

bool

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

RenderProperties(IDictionary<string, object>)

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

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

IDictionary<string, object>

Overrides
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

Implements

Constructs.IConstruct
Constructs.IDependable