Package software.amazon.awscdk.services.mediastore

Class CfnContainer

java.lang.Object
software.amazon.jsii.JsiiObject
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.mediastore.CfnContainer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.331Z") @Stability(Stable) public class CfnContainer extends CfnResource implements IInspectable
A CloudFormation AWS::MediaStore::Container.

The AWS::MediaStore::Container resource specifies a storage container to hold objects. A container is similar to a bucket in Amazon S3.

When you create a container using AWS CloudFormation , the template manages data for five API actions: creating a container, setting access logging, updating the default container policy, adding a cross-origin resource sharing (CORS) policy, and adding an object lifecycle policy.

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.mediastore.*;
 CfnContainer cfnContainer = CfnContainer.Builder.create(this, "MyCfnContainer")
         .containerName("containerName")
         // the properties below are optional
         .accessLoggingEnabled(false)
         .corsPolicy(List.of(CorsRuleProperty.builder()
                 .allowedHeaders(List.of("allowedHeaders"))
                 .allowedMethods(List.of("allowedMethods"))
                 .allowedOrigins(List.of("allowedOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAgeSeconds(123)
                 .build()))
         .lifecyclePolicy("lifecyclePolicy")
         .metricPolicy(MetricPolicyProperty.builder()
                 .containerLevelMetrics("containerLevelMetrics")
                 // the properties below are optional
                 .metricPolicyRules(List.of(MetricPolicyRuleProperty.builder()
                         .objectGroup("objectGroup")
                         .objectGroupName("objectGroupName")
                         .build()))
                 .build())
         .policy("policy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnContainer

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

    • CfnContainer

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

    • CfnContainer

      @Stability(Stable) public CfnContainer(@NotNull Construct scope, @NotNull String id, @NotNull CfnContainerProps props)
      Create a new AWS::MediaStore::Container.

      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 Details

    • 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.

    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      The DNS endpoint of the container.

      Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      AWS::MediaStore::Container.Tags.

    • getContainerName

      @Stability(Stable) @NotNull public String getContainerName()
      The name for the container.

      The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

    • setContainerName

      @Stability(Stable) public void setContainerName(@NotNull String value)
      The name for the container.

      The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

    • getAccessLoggingEnabled

      @Stability(Stable) @Nullable public Object getAccessLoggingEnabled()
      The state of access logging on the container.

      This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true , indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

    • setAccessLoggingEnabled

      @Stability(Stable) public void setAccessLoggingEnabled(@Nullable Boolean value)
      The state of access logging on the container.

      This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true , indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

    • setAccessLoggingEnabled

      @Stability(Stable) public void setAccessLoggingEnabled(@Nullable IResolvable value)
      The state of access logging on the container.

      This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true , indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

    • getCorsPolicy

      @Stability(Stable) @Nullable public Object getCorsPolicy()
      Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.

      For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

      To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

      To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore .

    • setCorsPolicy

      @Stability(Stable) public void setCorsPolicy(@Nullable IResolvable value)
      Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.

      For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

      To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

      To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore .

    • setCorsPolicy

      @Stability(Stable) public void setCorsPolicy(@Nullable List<Object> value)
      Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.

      For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

      To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

      To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore .

    • getLifecyclePolicy

      @Stability(Stable) @Nullable public String getLifecyclePolicy()
      Writes an object lifecycle policy to a container.

      If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.

      For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy .

    • setLifecyclePolicy

      @Stability(Stable) public void setLifecyclePolicy(@Nullable String value)
      Writes an object lifecycle policy to a container.

      If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.

      For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy .

    • getMetricPolicy

      @Stability(Stable) @Nullable public Object getMetricPolicy()
      AWS::MediaStore::Container.MetricPolicy.

    • setMetricPolicy

      @Stability(Stable) public void setMetricPolicy(@Nullable IResolvable value)
      AWS::MediaStore::Container.MetricPolicy.

    • setMetricPolicy

      @Stability(Stable) public void setMetricPolicy(@Nullable CfnContainer.MetricPolicyProperty value)
      AWS::MediaStore::Container.MetricPolicy.

    • getPolicy

      @Stability(Stable) @Nullable public String getPolicy()
      Creates an access policy for the specified container to restrict the users and clients that can access it.

      For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide .

      For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable String value)
      Creates an access policy for the specified container to restrict the users and clients that can access it.

      For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide .

      For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.