awsmediastore

Documentation

Index

• func CfnContainer_CFN_RESOURCE_TYPE_NAME() *string
• func CfnContainer_IsCfnElement(x interface{}) *bool
• func CfnContainer_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnContainer_IsConstruct(x interface{}) *bool
• func NewCfnContainer_Override(c CfnContainer, scope constructs.Construct, id *string, ...)
• type CfnContainer
  • func NewCfnContainer(scope constructs.Construct, id *string, props *CfnContainerProps) CfnContainer
• type CfnContainerProps
• type CfnContainer_CorsRuleProperty
• type CfnContainer_MetricPolicyProperty
• type CfnContainer_MetricPolicyRuleProperty

Functions

func CfnContainer_CFN_RESOURCE_TYPE_NAME

func CfnContainer_CFN_RESOURCE_TYPE_NAME() *string

func CfnContainer_IsCfnElement

func CfnContainer_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnContainer_IsCfnResource

func CfnContainer_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContainer_IsConstruct

func CfnContainer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnContainer_Override

func NewCfnContainer_Override(c CfnContainer, scope constructs.Construct, id *string, props *CfnContainerProps)

Create a new `AWS::MediaStore::Container`.

Types

type CfnContainer

type CfnContainer interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccessLoggingEnabled() interface{}
	SetAccessLoggingEnabled(val interface{})
	AttrEndpoint() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ContainerName() *string
	SetContainerName(val *string)
	CorsPolicy() interface{}
	SetCorsPolicy(val interface{})
	CreationStack() *[]*string
	LifecyclePolicy() *string
	SetLifecyclePolicy(val *string)
	LogicalId() *string
	MetricPolicy() interface{}
	SetMetricPolicy(val interface{})
	Node() constructs.Node
	Policy() *string
	SetPolicy(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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.

TODO: EXAMPLE

func NewCfnContainer

func NewCfnContainer(scope constructs.Construct, id *string, props *CfnContainerProps) CfnContainer

Create a new `AWS::MediaStore::Container`.

type CfnContainerProps

type CfnContainerProps struct {
	// 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.
	ContainerName *string `json:"containerName" yaml:"containerName"`
	// 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.
	AccessLoggingEnabled interface{} `json:"accessLoggingEnabled" yaml:"accessLoggingEnabled"`
	// 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](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html) .
	CorsPolicy interface{} `json:"corsPolicy" yaml:"corsPolicy"`
	// 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](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html) .
	LifecyclePolicy *string `json:"lifecyclePolicy" yaml:"lifecyclePolicy"`
	// `AWS::MediaStore::Container.MetricPolicy`.
	MetricPolicy interface{} `json:"metricPolicy" yaml:"metricPolicy"`
	// 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](https://docs.aws.amazon.com/iam/) .
	//
	// 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.
	Policy *string `json:"policy" yaml:"policy"`
	// `AWS::MediaStore::Container.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnContainer`.

TODO: EXAMPLE

type CfnContainer_CorsRuleProperty

type CfnContainer_CorsRuleProperty struct {
	// Specifies which headers are allowed in a preflight `OPTIONS` request through the `Access-Control-Request-Headers` header.
	//
	// Each header name that is specified in `Access-Control-Request-Headers` must have a corresponding entry in the rule. Only the headers that were requested are sent back.
	//
	// This element can contain only one wildcard character (*).
	AllowedHeaders *[]*string `json:"allowedHeaders" yaml:"allowedHeaders"`
	// Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
	//
	// Each CORS rule must contain at least one `AllowedMethods` and one `AllowedOrigins` element.
	AllowedMethods *[]*string `json:"allowedMethods" yaml:"allowedMethods"`
	// One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript `XMLHttpRequest` object).
	//
	// Each CORS rule must have at least one `AllowedOrigins` element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.
	AllowedOrigins *[]*string `json:"allowedOrigins" yaml:"allowedOrigins"`
	// One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript `XMLHttpRequest` object).
	//
	// This element is optional for each rule.
	ExposeHeaders *[]*string `json:"exposeHeaders" yaml:"exposeHeaders"`
	// The time in seconds that your browser caches the preflight response for the specified resource.
	//
	// A CORS rule can have only one `MaxAgeSeconds` element.
	MaxAgeSeconds *float64 `json:"maxAgeSeconds" yaml:"maxAgeSeconds"`
}

A rule for a CORS policy.

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.

TODO: EXAMPLE

type CfnContainer_MetricPolicyProperty

type CfnContainer_MetricPolicyProperty struct {
	// A setting to enable or disable metrics at the container level.
	ContainerLevelMetrics *string `json:"containerLevelMetrics" yaml:"containerLevelMetrics"`
	// A parameter that holds an array of rules that enable metrics at the object level.
	//
	// This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also [request a quota increase](https://docs.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) to allow up to 300 rules per policy.
	MetricPolicyRules interface{} `json:"metricPolicyRules" yaml:"metricPolicyRules"`
}

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](https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html) .

TODO: EXAMPLE

type CfnContainer_MetricPolicyRuleProperty

type CfnContainer_MetricPolicyRuleProperty struct {
	// A path or file name that defines which objects to include in the group.
	//
	// Wildcards (*) are acceptable.
	ObjectGroup *string `json:"objectGroup" yaml:"objectGroup"`
	// A name that allows you to refer to the object group.
	ObjectGroupName *string `json:"objectGroupName" yaml:"objectGroupName"`
}

A setting that enables metrics at the object level.

Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also [request a quota increase](https://docs.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) to allow up to 300 rules per policy.

TODO: EXAMPLE