Package software.amazon.awscdk.services.mediastore

Class CfnContainer.Builder

java.lang.Object

software.amazon.awscdk.services.mediastore.CfnContainer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainer>

Enclosing class:

CfnContainer

@Stability(Stable)
public static final class CfnContainer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainer>

A fluent builder for CfnContainer.

Method Summary

Modifier and Type	Method	Description
CfnContainer.Builder	accessLoggingEnabled(Boolean accessLoggingEnabled)	The state of access logging on the container.
CfnContainer.Builder	accessLoggingEnabled(IResolvable accessLoggingEnabled)	The state of access logging on the container.
CfnContainer	build()
CfnContainer.Builder	containerName(String containerName)	The name for the container.
CfnContainer.Builder	corsPolicy(List<? extends Object> corsPolicy)	Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
CfnContainer.Builder	corsPolicy(IResolvable corsPolicy)	Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
static CfnContainer.Builder	create(software.constructs.Construct scope, String id)
CfnContainer.Builder	lifecyclePolicy(String lifecyclePolicy)	Writes an object lifecycle policy to a container.
CfnContainer.Builder	metricPolicy(IResolvable metricPolicy)	The metric policy that is associated with the container.
CfnContainer.Builder	metricPolicy(CfnContainer.MetricPolicyProperty metricPolicy)	The metric policy that is associated with the container.
CfnContainer.Builder	policy(String policy)	Creates an access policy for the specified container to restrict the users and clients that can access it.
CfnContainer.Builder	tags(List<? extends CfnTag> tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnContainer.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnContainer.Builder.

containerName

@Stability(Stable)
public CfnContainer.Builder containerName(String containerName)

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.

Parameters:

containerName - The name for the container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-containername

accessLoggingEnabled

@Stability(Stable)
public CfnContainer.Builder accessLoggingEnabled(Boolean accessLoggingEnabled)

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.

Parameters:

accessLoggingEnabled - The state of access logging on the container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-accessloggingenabled

accessLoggingEnabled

@Stability(Stable)
public CfnContainer.Builder accessLoggingEnabled(IResolvable accessLoggingEnabled)

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.

Parameters:

accessLoggingEnabled - The state of access logging on the container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-accessloggingenabled

corsPolicy

@Stability(Stable)
public CfnContainer.Builder corsPolicy(IResolvable corsPolicy)

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 .

Parameters:

corsPolicy - Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-corspolicy

corsPolicy

@Stability(Stable)
public CfnContainer.Builder corsPolicy(List<? extends Object> corsPolicy)

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 .

Parameters:

corsPolicy - Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-corspolicy

lifecyclePolicy

@Stability(Stable)
public CfnContainer.Builder lifecyclePolicy(String lifecyclePolicy)

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 .

Parameters:

lifecyclePolicy - Writes an object lifecycle policy to a container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-lifecyclepolicy

metricPolicy

@Stability(Stable)
public CfnContainer.Builder metricPolicy(IResolvable metricPolicy)

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 .

Parameters:

metricPolicy - The metric policy that is associated with the container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-metricpolicy

metricPolicy

@Stability(Stable)
public CfnContainer.Builder metricPolicy(CfnContainer.MetricPolicyProperty metricPolicy)

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 .

Parameters:

metricPolicy - The metric policy that is associated with the container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-metricpolicy

policy

@Stability(Stable)
public CfnContainer.Builder policy(String policy)

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.

Parameters:

policy - Creates an access policy for the specified container to restrict the users and clients that can access it. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-policy

tags

@Stability(Stable)
public CfnContainer.Builder tags(List<? extends CfnTag> tags)

Parameters:

tags - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-tags

build

@Stability(Stable)
public CfnContainer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainer>

Returns:

a newly built instance of CfnContainer.