Class CfnLoggingConfiguration
A CloudFormation AWS::IVSChat::LoggingConfiguration
.
Inherited Members
Namespace: Amazon.CDK.AWS.IVSChat
Assembly: Amazon.CDK.AWS.IVSChat.dll
Syntax (csharp)
public class CfnLoggingConfiguration : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLoggingConfiguration
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::IVSChat::LoggingConfiguration
resource specifies an logging configuration that allows clients to store and record sent messages. For more information, see CreateLoggingConfiguration in the Amazon Interactive Video Service Chat API Reference .
CloudformationResource: AWS::IVSChat::LoggingConfiguration
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.IVSChat;
var cfnLoggingConfiguration = new CfnLoggingConfiguration(this, "MyCfnLoggingConfiguration", new CfnLoggingConfigurationProps {
DestinationConfiguration = new DestinationConfigurationProperty {
CloudWatchLogs = new CloudWatchLogsDestinationConfigurationProperty {
LogGroupName = "logGroupName"
},
Firehose = new FirehoseDestinationConfigurationProperty {
DeliveryStreamName = "deliveryStreamName"
},
S3 = new S3DestinationConfigurationProperty {
BucketName = "bucketName"
}
},
// the properties below are optional
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnLoggingConfiguration(Construct, String, ICfnLoggingConfigurationProps) | Create a new |
CfnLoggingConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLoggingConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The logging-configuration ARN. |
AttrId | The logging-configuration ID. |
AttrState | Indicates the current state of the logging configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DestinationConfiguration | The DestinationConfiguration is a complex type that contains information about where chat content will be logged. |
Name | Logging-configuration name. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLoggingConfiguration(Construct, String, ICfnLoggingConfigurationProps)
Create a new AWS::IVSChat::LoggingConfiguration
.
public CfnLoggingConfiguration(Construct scope, string id, ICfnLoggingConfigurationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnLoggingConfigurationProps
- resource properties.
CfnLoggingConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLoggingConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLoggingConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLoggingConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The logging-configuration ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivschat:us-west-2:123456789012:logging-configuration/abcdABCDefgh
CloudformationAttribute: Arn
AttrId
The logging-configuration ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example: abcdABCDefgh
CloudformationAttribute: Id
AttrState
Indicates the current state of the logging configuration.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
When the state is ACTIVE
, the configuration is ready to log a chat session. Valid values: CREATING
| CREATE_FAILED
| DELETING
| DELETE_FAILED
| UPDATING
| UPDATE_FAILED
| ACTIVE
.
CloudformationAttribute: State
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
DestinationConfiguration
The DestinationConfiguration is a complex type that contains information about where chat content will be logged.
public virtual object DestinationConfiguration { get; set; }
Property Value
System.Object
Remarks
Name
Logging-configuration name.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The value does not need to be unique.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>