Package software.amazon.awscdk.services.ivs

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, IEnvironmentAware, IStorageConfigurationRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:12.140Z") @Stability(Stable) public class CfnStorageConfiguration extends CfnResource implements IInspectable, IStorageConfigurationRef, 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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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)
      Create a new AWS::IVS::StorageConfiguration.

      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

    • arnForStorageConfiguration

      @Stability(Stable) @NotNull public static String arnForStorageConfiguration(@NotNull IStorageConfigurationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnStorageConfiguration

      @Stability(Stable) @NotNull public static Boolean isCfnStorageConfiguration(@NotNull Object x)
      Checks whether the given object is a CfnStorageConfiguration.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The storage-configuration ARN.

      For example: arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStorageConfigurationRef

      @Stability(Stable) @NotNull public StorageConfigurationReference getStorageConfigurationRef()
      A reference to a StorageConfiguration resource.
      Specified by:
      getStorageConfigurationRef in interface IStorageConfigurationRef

    • getS3

      @Stability(Stable) @NotNull public Object getS3()
      An S3 storage configuration contains information about where recorded video will be stored.

      Returns union: either IResolvable or CfnStorageConfiguration.S3StorageConfigurationProperty

    • setS3

      @Stability(Stable) public void setS3(@NotNull IResolvable value)
      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

      @Stability(Stable) @Nullable public String getName()
      Storage cnfiguration name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Storage cnfiguration name.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.