Class CfnStorageConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ivs.CfnStorageConfiguration
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:56:00.584Z")
@Stability(Stable)
public class CfnStorageConfiguration
extends CfnResource
implements IInspectable, ITaggableV2
The
AWS::IVS::StorageConfiguration
resource specifies an storage configuration.
A storage configuration describes an S3 location where recorded videos will be stored. For more information, see Auto-Record to Amazon S3 (Low-Latency Streaming) in the Amazon IVS Low-Latency Streaming User Guide .
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.ivs.*; CfnStorageConfiguration cfnStorageConfiguration = CfnStorageConfiguration.Builder.create(this, "MyCfnStorageConfiguration") .s3(S3StorageConfigurationProperty.builder() .bucketName("bucketName") .build()) // the properties below are optional .name("name") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnStorageConfiguration
.static interface
The S3StorageConfiguration property type describes an S3 location where recorded videos will be stored.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnStorageConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnStorageConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) CfnStorageConfiguration
(software.constructs.Construct scope, String id, CfnStorageConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe storage-configuration ARN.Tag Manager which manages the tags for this resource.getName()
Storage cnfiguration name.getS3()
An S3 storage configuration contains information about where recorded video will be stored.getTags()
An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Storage cnfiguration name.void
setS3
(IResolvable value) An S3 storage configuration contains information about where recorded video will be stored.void
An S3 storage configuration contains information about where recorded video will be stored.void
An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnStorageConfiguration
protected CfnStorageConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
CfnStorageConfiguration
protected CfnStorageConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnStorageConfiguration
@Stability(Stable) public CfnStorageConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStorageConfigurationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The storage-configuration ARN.For example:
arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getS3
An S3 storage configuration contains information about where recorded video will be stored. -
setS3
An S3 storage configuration contains information about where recorded video will be stored. -
setS3
@Stability(Stable) public void setS3(@NotNull CfnStorageConfiguration.S3StorageConfigurationProperty value) An S3 storage configuration contains information about where recorded video will be stored. -
getName
Storage cnfiguration name. -
setName
Storage cnfiguration name. -
getTags
An array of key-value pairs to apply to this resource. -
setTags
An array of key-value pairs to apply to this resource.
-