Documentation
¶
Index ¶
- func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoggingConfiguration_IsCfnElement(x interface{}) *bool
- func CfnLoggingConfiguration_IsCfnResource(x interface{}) *bool
- func CfnLoggingConfiguration_IsConstruct(x interface{}) *bool
- func CfnRoom_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRoom_IsCfnElement(x interface{}) *bool
- func CfnRoom_IsCfnResource(x interface{}) *bool
- func CfnRoom_IsConstruct(x interface{}) *bool
- func NewCfnLoggingConfiguration_Override(c CfnLoggingConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnRoom_Override(c CfnRoom, scope constructs.Construct, id *string, props *CfnRoomProps)
- type CfnLoggingConfiguration
- type CfnLoggingConfigurationProps
- type CfnLoggingConfiguration_CloudWatchLogsDestinationConfigurationProperty
- type CfnLoggingConfiguration_DestinationConfigurationProperty
- type CfnLoggingConfiguration_FirehoseDestinationConfigurationProperty
- type CfnLoggingConfiguration_S3DestinationConfigurationProperty
- type CfnRoom
- type CfnRoomProps
- type CfnRoom_MessageReviewHandlerProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoggingConfiguration_IsCfnElement ¶
func CfnLoggingConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoggingConfiguration_IsCfnResource ¶
func CfnLoggingConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLoggingConfiguration_IsConstruct ¶
func CfnLoggingConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRoom_CFN_RESOURCE_TYPE_NAME ¶
func CfnRoom_CFN_RESOURCE_TYPE_NAME() *string
func CfnRoom_IsCfnElement ¶
func CfnRoom_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRoom_IsCfnResource ¶
func CfnRoom_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRoom_IsConstruct ¶
func CfnRoom_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnLoggingConfiguration_Override ¶
func NewCfnLoggingConfiguration_Override(c CfnLoggingConfiguration, scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps)
Create a new `AWS::IVSChat::LoggingConfiguration`.
func NewCfnRoom_Override ¶
func NewCfnRoom_Override(c CfnRoom, scope constructs.Construct, id *string, props *CfnRoomProps)
Create a new `AWS::IVSChat::Room`.
Types ¶
type CfnLoggingConfiguration ¶
type CfnLoggingConfiguration interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsivschat.ILoggingConfigurationRef
awscdk.ITaggable
// The logging-configuration ARN.
//
// For example: `arn:aws:ivschat:us-west-2:123456789012:logging-configuration/abcdABCDefgh`.
AttrArn() *string
// The logging-configuration ID.
//
// For example: `abcdABCDefgh`.
AttrId() *string
// Indicates the current state of the logging configuration.
//
// 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` .
AttrState() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The DestinationConfiguration is a complex type that contains information about where chat content will be logged.
DestinationConfiguration() interface{}
SetDestinationConfiguration(val interface{})
Env() *interfaces.ResourceEnvironment
// A reference to a LoggingConfiguration resource.
LoggingConfigurationRef() *interfacesawsivschat.LoggingConfigurationReference
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// Logging-configuration name.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::IVSChat::LoggingConfiguration` resource specifies an logging configuration that allows clients to store and record sent messages.
For more information, see [CreateLoggingConfiguration](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_CreateLoggingConfiguration.html) in the *Amazon Interactive Video Service Chat API Reference* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoggingConfiguration := awscdk.Aws_ivschat.NewCfnLoggingConfiguration(this, jsii.String("MyCfnLoggingConfiguration"), &CfnLoggingConfigurationProps{
DestinationConfiguration: &DestinationConfigurationProperty{
CloudWatchLogs: &CloudWatchLogsDestinationConfigurationProperty{
LogGroupName: jsii.String("logGroupName"),
},
Firehose: &FirehoseDestinationConfigurationProperty{
DeliveryStreamName: jsii.String("deliveryStreamName"),
},
S3: &S3DestinationConfigurationProperty{
BucketName: jsii.String("bucketName"),
},
},
// the properties below are optional
Name: jsii.String("name"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnLoggingConfiguration ¶
func NewCfnLoggingConfiguration(scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps) CfnLoggingConfiguration
Create a new `AWS::IVSChat::LoggingConfiguration`.
type CfnLoggingConfigurationProps ¶
type CfnLoggingConfigurationProps struct {
// The DestinationConfiguration is a complex type that contains information about where chat content will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-loggingconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration
//
DestinationConfiguration interface{} `field:"required" json:"destinationConfiguration" yaml:"destinationConfiguration"`
// Logging-configuration name.
//
// The value does not need to be unique.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-loggingconfiguration.html#cfn-ivschat-loggingconfiguration-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-tag.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-loggingconfiguration.html#cfn-ivschat-loggingconfiguration-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLoggingConfiguration`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoggingConfigurationProps := &CfnLoggingConfigurationProps{
DestinationConfiguration: &DestinationConfigurationProperty{
CloudWatchLogs: &CloudWatchLogsDestinationConfigurationProperty{
LogGroupName: jsii.String("logGroupName"),
},
Firehose: &FirehoseDestinationConfigurationProperty{
DeliveryStreamName: jsii.String("deliveryStreamName"),
},
S3: &S3DestinationConfigurationProperty{
BucketName: jsii.String("bucketName"),
},
},
// the properties below are optional
Name: jsii.String("name"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLoggingConfiguration_CloudWatchLogsDestinationConfigurationProperty ¶
type CfnLoggingConfiguration_CloudWatchLogsDestinationConfigurationProperty struct {
// Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration.html#cfn-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-loggroupname
//
LogGroupName *string `field:"required" json:"logGroupName" yaml:"logGroupName"`
}
The CloudWatchLogsDestinationConfiguration property type specifies a CloudWatch Logs location where chat logs will be stored.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cloudWatchLogsDestinationConfigurationProperty := &CloudWatchLogsDestinationConfigurationProperty{
LogGroupName: jsii.String("logGroupName"),
}
type CfnLoggingConfiguration_DestinationConfigurationProperty ¶
type CfnLoggingConfiguration_DestinationConfigurationProperty struct {
// An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-cloudwatchlogs
//
CloudWatchLogs interface{} `field:"optional" json:"cloudWatchLogs" yaml:"cloudWatchLogs"`
// An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-firehose
//
Firehose interface{} `field:"optional" json:"firehose" yaml:"firehose"`
// An Amazon S3 destination configuration where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
The DestinationConfiguration property type describes a location where chat logs will be stored.
Each member represents the configuration of one log destination. For logging, you define only one type of destination.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
destinationConfigurationProperty := &DestinationConfigurationProperty{
CloudWatchLogs: &CloudWatchLogsDestinationConfigurationProperty{
LogGroupName: jsii.String("logGroupName"),
},
Firehose: &FirehoseDestinationConfigurationProperty{
DeliveryStreamName: jsii.String("deliveryStreamName"),
},
S3: &S3DestinationConfigurationProperty{
BucketName: jsii.String("bucketName"),
},
}
type CfnLoggingConfiguration_FirehoseDestinationConfigurationProperty ¶
type CfnLoggingConfiguration_FirehoseDestinationConfigurationProperty struct {
// Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration.html#cfn-ivschat-loggingconfiguration-firehosedestinationconfiguration-deliverystreamname
//
DeliveryStreamName *string `field:"required" json:"deliveryStreamName" yaml:"deliveryStreamName"`
}
The FirehoseDestinationConfiguration property type specifies a Kinesis Firehose location where chat logs will be stored.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
firehoseDestinationConfigurationProperty := &FirehoseDestinationConfigurationProperty{
DeliveryStreamName: jsii.String("deliveryStreamName"),
}
type CfnLoggingConfiguration_S3DestinationConfigurationProperty ¶
type CfnLoggingConfiguration_S3DestinationConfigurationProperty struct {
// Name of the Amazon S3 bucket where chat activity will be logged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration.html#cfn-ivschat-loggingconfiguration-s3destinationconfiguration-bucketname
//
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
}
The S3DestinationConfiguration property type specifies an S3 location where chat logs will be stored.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3DestinationConfigurationProperty := &S3DestinationConfigurationProperty{
BucketName: jsii.String("bucketName"),
}
type CfnRoom ¶
type CfnRoom interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsivschat.IRoomRef
awscdk.ITaggable
// The room ARN.
//
// For example: `arn:aws:ivschat:us-west-2:123456789012:room/abcdABCDefgh`.
AttrArn() *string
// The room ID.
//
// For example: `abcdABCDefgh`.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// List of logging-configuration identifiers attached to the room.
LoggingConfigurationIdentifiers() *[]*string
SetLoggingConfigurationIdentifiers(val *[]*string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// Maximum number of characters in a single message.
MaximumMessageLength() *float64
SetMaximumMessageLength(val *float64)
// Maximum number of messages per second that can be sent to the room (by all clients).
MaximumMessageRatePerSecond() *float64
SetMaximumMessageRatePerSecond(val *float64)
// Configuration information for optional review of messages.
MessageReviewHandler() interface{}
SetMessageReviewHandler(val interface{})
// Room name.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A reference to a Room resource.
RoomRef() *interfacesawsivschat.RoomReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::IVSChat::Room` resource specifies an room that allows clients to connect and pass messages.
For more information, see [CreateRoom](https://docs.aws.amazon.com/ivs/latest/ChatAPIReference/API_CreateRoom.html) in the *Amazon Interactive Video Service Chat API Reference* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRoom := awscdk.Aws_ivschat.NewCfnRoom(this, jsii.String("MyCfnRoom"), &CfnRoomProps{
LoggingConfigurationIdentifiers: []*string{
jsii.String("loggingConfigurationIdentifiers"),
},
MaximumMessageLength: jsii.Number(123),
MaximumMessageRatePerSecond: jsii.Number(123),
MessageReviewHandler: &MessageReviewHandlerProperty{
FallbackResult: jsii.String("fallbackResult"),
Uri: jsii.String("uri"),
},
Name: jsii.String("name"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html
func NewCfnRoom ¶
func NewCfnRoom(scope constructs.Construct, id *string, props *CfnRoomProps) CfnRoom
Create a new `AWS::IVSChat::Room`.
type CfnRoomProps ¶
type CfnRoomProps struct {
// List of logging-configuration identifiers attached to the room.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-loggingconfigurationidentifiers
//
LoggingConfigurationIdentifiers *[]*string `field:"optional" json:"loggingConfigurationIdentifiers" yaml:"loggingConfigurationIdentifiers"`
// Maximum number of characters in a single message.
//
// Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-maximummessagelength
//
// Default: - 500.
//
MaximumMessageLength *float64 `field:"optional" json:"maximumMessageLength" yaml:"maximumMessageLength"`
// Maximum number of messages per second that can be sent to the room (by all clients).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-maximummessageratepersecond
//
// Default: - 10.
//
MaximumMessageRatePerSecond *float64 `field:"optional" json:"maximumMessageRatePerSecond" yaml:"maximumMessageRatePerSecond"`
// Configuration information for optional review of messages.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-messagereviewhandler
//
MessageReviewHandler interface{} `field:"optional" json:"messageReviewHandler" yaml:"messageReviewHandler"`
// Room name.
//
// The value does not need to be unique.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-room-tag.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRoom`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRoomProps := &CfnRoomProps{
LoggingConfigurationIdentifiers: []*string{
jsii.String("loggingConfigurationIdentifiers"),
},
MaximumMessageLength: jsii.Number(123),
MaximumMessageRatePerSecond: jsii.Number(123),
MessageReviewHandler: &MessageReviewHandlerProperty{
FallbackResult: jsii.String("fallbackResult"),
Uri: jsii.String("uri"),
},
Name: jsii.String("name"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html
type CfnRoom_MessageReviewHandlerProperty ¶
type CfnRoom_MessageReviewHandlerProperty struct {
// Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out.
//
// (For the timeout period, see [Service Quotas](https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html) .) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user.
//
// *Default* : `ALLOW`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-room-messagereviewhandler.html#cfn-ivschat-room-messagereviewhandler-fallbackresult
//
// Default: - "ALLOW".
//
FallbackResult *string `field:"optional" json:"fallbackResult" yaml:"fallbackResult"`
// Identifier of the message review handler.
//
// Currently this must be an ARN of a lambda function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-room-messagereviewhandler.html#cfn-ivschat-room-messagereviewhandler-uri
//
Uri *string `field:"optional" json:"uri" yaml:"uri"`
}
The MessageReviewHandler property type specifies configuration information for optional message review.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
messageReviewHandlerProperty := &MessageReviewHandlerProperty{
FallbackResult: jsii.String("fallbackResult"),
Uri: jsii.String("uri"),
}
Source Files
¶
- CfnLoggingConfiguration.go
- CfnLoggingConfigurationProps.go
- CfnLoggingConfiguration_CloudWatchLogsDestinationConfigurationProperty.go
- CfnLoggingConfiguration_DestinationConfigurationProperty.go
- CfnLoggingConfiguration_FirehoseDestinationConfigurationProperty.go
- CfnLoggingConfiguration_S3DestinationConfigurationProperty.go
- CfnLoggingConfiguration__checks.go
- CfnRoom.go
- CfnRoomProps.go
- CfnRoom_MessageReviewHandlerProperty.go
- CfnRoom__checks.go
- main.go