interface CfnContainerProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.MediaStore.CfnContainerProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsmediastore#CfnContainerProps |
![]() | software.amazon.awscdk.services.mediastore.CfnContainerProps |
![]() | aws_cdk.aws_mediastore.CfnContainerProps |
![]() | aws-cdk-lib » aws_mediastore » CfnContainerProps |
Properties for defining a CfnContainer
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediastore as mediastore } from 'aws-cdk-lib';
const cfnContainerProps: mediastore.CfnContainerProps = {
containerName: 'containerName',
// the properties below are optional
accessLoggingEnabled: false,
corsPolicy: [{
allowedHeaders: ['allowedHeaders'],
allowedMethods: ['allowedMethods'],
allowedOrigins: ['allowedOrigins'],
exposeHeaders: ['exposeHeaders'],
maxAgeSeconds: 123,
}],
lifecyclePolicy: 'lifecyclePolicy',
metricPolicy: {
containerLevelMetrics: 'containerLevelMetrics',
// the properties below are optional
metricPolicyRules: [{
objectGroup: 'objectGroup',
objectGroupName: 'objectGroupName',
}],
},
policy: 'policy',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
container | string | The name for the container. |
access | boolean | IResolvable | The state of access logging on the container. |
cors | IResolvable | IResolvable | Cors [] | > End of support notice: On November 13, 2025, AWS will discontinue support for AWS Elemental MediaStore. |
lifecycle | string | > End of support notice: On November 13, 2025, AWS will discontinue support for AWS Elemental MediaStore. |
metric | IResolvable | Metric | The metric policy that is associated with the container. |
policy? | string | Creates an access policy for the specified container to restrict the users and clients that can access it. |
tags? | Cfn [] |
containerName
Type:
string
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.
accessLoggingEnabled?
Type:
boolean |
IResolvable
(optional)
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.
corsPolicy?
Type:
IResolvable
|
IResolvable
|
Cors
[]
(optional)
End of support notice: On November 13, 2025, AWS will discontinue support for AWS Elemental MediaStore.
After November 13, 2025, you will no longer be able to access the AWS Elemental MediaStore console or AWS Elemental MediaStore resources. For more information, visit this blog post .
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 .
lifecyclePolicy?
Type:
string
(optional)
End of support notice: On November 13, 2025, AWS will discontinue support for AWS Elemental MediaStore.
After November 13, 2025, you will no longer be able to access the AWS Elemental MediaStore console or AWS Elemental MediaStore resources. For more information, visit this blog post .
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 .
metricPolicy?
Type:
IResolvable
|
Metric
(optional)
The metric policy that is associated with the container.
A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.
To view examples of how to construct a metric policy for your use case, see Example Metric Policies .
policy?
Type:
string
(optional)
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.
tags?
Type:
Cfn
[]
(optional)