software.amazon.awscdk.services.connect

Class CfnInstanceStorageConfig

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.connect.CfnInstanceStorageConfig

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.622Z")
public class CfnInstanceStorageConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Connect::InstanceStorageConfig`.

The storage configuration for the instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnInstanceStorageConfig cfnInstanceStorageConfig = CfnInstanceStorageConfig.Builder.create(this, "MyCfnInstanceStorageConfig")
         .instanceArn("instanceArn")
         .resourceType("resourceType")
         .storageType("storageType")
         // the properties below are optional
         .kinesisFirehoseConfig(KinesisFirehoseConfigProperty.builder()
                 .firehoseArn("firehoseArn")
                 .build())
         .kinesisStreamConfig(KinesisStreamConfigProperty.builder()
                 .streamArn("streamArn")
                 .build())
         .kinesisVideoStreamConfig(KinesisVideoStreamConfigProperty.builder()
                 .prefix("prefix")
                 .retentionPeriodHours(123)
                 // the properties below are optional
                 .encryptionConfig(EncryptionConfigProperty.builder()
                         .encryptionType("encryptionType")
                         .keyId("keyId")
                         .build())
                 .build())
         .s3Config(S3ConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 // the properties below are optional
                 .encryptionConfig(EncryptionConfigProperty.builder()
                         .encryptionType("encryptionType")
                         .keyId("keyId")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnInstanceStorageConfig.Builder A fluent builder for CfnInstanceStorageConfig.
static interface	CfnInstanceStorageConfig.EncryptionConfigProperty The encryption configuration.
static interface	CfnInstanceStorageConfig.KinesisFirehoseConfigProperty Configuration information of a Kinesis Data Firehose delivery stream.
static interface	CfnInstanceStorageConfig.KinesisStreamConfigProperty Configuration information of a Kinesis data stream.
static interface	CfnInstanceStorageConfig.KinesisVideoStreamConfigProperty Configuration information of a Kinesis video stream.
static interface	CfnInstanceStorageConfig.S3ConfigProperty Information about the Amazon Simple Storage Service (Amazon S3) storage type.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInstanceStorageConfig(Construct scope, java.lang.String id, CfnInstanceStorageConfigProps props) Create a new `AWS::Connect::InstanceStorageConfig`.
protected	CfnInstanceStorageConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInstanceStorageConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAssociationId() The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getInstanceArn() The Amazon Resource Name (ARN) of the instance.
java.lang.Object	getKinesisFirehoseConfig() The configuration of the Kinesis Firehose delivery stream.
java.lang.Object	getKinesisStreamConfig() The configuration of the Kinesis data stream.
java.lang.Object	getKinesisVideoStreamConfig() The configuration of the Kinesis video stream.
java.lang.String	getResourceType() A valid resource type.
java.lang.Object	getS3Config() The S3 bucket configuration.
java.lang.String	getStorageType() A valid storage type.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setInstanceArn(java.lang.String value) The Amazon Resource Name (ARN) of the instance.
void	setKinesisFirehoseConfig(CfnInstanceStorageConfig.KinesisFirehoseConfigProperty value) The configuration of the Kinesis Firehose delivery stream.
void	setKinesisFirehoseConfig(IResolvable value) The configuration of the Kinesis Firehose delivery stream.
void	setKinesisStreamConfig(CfnInstanceStorageConfig.KinesisStreamConfigProperty value) The configuration of the Kinesis data stream.
void	setKinesisStreamConfig(IResolvable value) The configuration of the Kinesis data stream.
void	setKinesisVideoStreamConfig(CfnInstanceStorageConfig.KinesisVideoStreamConfigProperty value) The configuration of the Kinesis video stream.
void	setKinesisVideoStreamConfig(IResolvable value) The configuration of the Kinesis video stream.
void	setResourceType(java.lang.String value) A valid resource type.
void	setS3Config(CfnInstanceStorageConfig.S3ConfigProperty value) The S3 bucket configuration.
void	setS3Config(IResolvable value) The S3 bucket configuration.
void	setStorageType(java.lang.String value) A valid storage type.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInstanceStorageConfig

protected CfnInstanceStorageConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnInstanceStorageConfig

protected CfnInstanceStorageConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInstanceStorageConfig

public CfnInstanceStorageConfig(Construct scope,
                                java.lang.String id,
                                CfnInstanceStorageConfigProps props)

Create a new `AWS::Connect::InstanceStorageConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociationId

public java.lang.String getAttrAssociationId()

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getInstanceArn

public java.lang.String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

public void setInstanceArn(java.lang.String value)

The Amazon Resource Name (ARN) of the instance.

getResourceType

public java.lang.String getResourceType()

A valid resource type.

Following are the valid resource types: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS

setResourceType

public void setResourceType(java.lang.String value)

A valid resource type.

Following are the valid resource types: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS

getStorageType

public java.lang.String getStorageType()

A valid storage type.

setStorageType

public void setStorageType(java.lang.String value)

A valid storage type.

getKinesisFirehoseConfig

public java.lang.Object getKinesisFirehoseConfig()

The configuration of the Kinesis Firehose delivery stream.

setKinesisFirehoseConfig

public void setKinesisFirehoseConfig(IResolvable value)

The configuration of the Kinesis Firehose delivery stream.

setKinesisFirehoseConfig

public void setKinesisFirehoseConfig(CfnInstanceStorageConfig.KinesisFirehoseConfigProperty value)

The configuration of the Kinesis Firehose delivery stream.

getKinesisStreamConfig

public java.lang.Object getKinesisStreamConfig()

The configuration of the Kinesis data stream.

setKinesisStreamConfig

public void setKinesisStreamConfig(IResolvable value)

The configuration of the Kinesis data stream.

setKinesisStreamConfig

public void setKinesisStreamConfig(CfnInstanceStorageConfig.KinesisStreamConfigProperty value)

The configuration of the Kinesis data stream.

getKinesisVideoStreamConfig

public java.lang.Object getKinesisVideoStreamConfig()

The configuration of the Kinesis video stream.

setKinesisVideoStreamConfig

public void setKinesisVideoStreamConfig(IResolvable value)

The configuration of the Kinesis video stream.

setKinesisVideoStreamConfig

public void setKinesisVideoStreamConfig(CfnInstanceStorageConfig.KinesisVideoStreamConfigProperty value)

The configuration of the Kinesis video stream.

getS3Config

public java.lang.Object getS3Config()

The S3 bucket configuration.

setS3Config

public void setS3Config(IResolvable value)

The S3 bucket configuration.

setS3Config

public void setS3Config(CfnInstanceStorageConfig.S3ConfigProperty value)

The S3 bucket configuration.