Class CfnContainer
The AWS::MediaStore::Container resource specifies a storage container to hold objects.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaStore
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContainer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnContainer
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html
CloudformationResource: AWS::MediaStore::Container
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaStore;
var cfnContainer = new CfnContainer(this, "MyCfnContainer", new CfnContainerProps {
ContainerName = "containerName",
// the properties below are optional
AccessLoggingEnabled = false,
CorsPolicy = new [] { new CorsRuleProperty {
AllowedHeaders = new [] { "allowedHeaders" },
AllowedMethods = new [] { "allowedMethods" },
AllowedOrigins = new [] { "allowedOrigins" },
ExposeHeaders = new [] { "exposeHeaders" },
MaxAgeSeconds = 123
} },
LifecyclePolicy = "lifecyclePolicy",
MetricPolicy = new MetricPolicyProperty {
ContainerLevelMetrics = "containerLevelMetrics",
// the properties below are optional
MetricPolicyRules = new [] { new MetricPolicyRuleProperty {
ObjectGroup = "objectGroup",
ObjectGroupName = "objectGroupName"
} }
},
Policy = "policy",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnContainer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnContainer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnContainer(Construct, String, ICfnContainerProps) |
Properties
AccessLoggingEnabled | The state of access logging on the container. |
AttrEndpoint | The DNS endpoint of the container. |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContainerName | The name for the container. |
CorsPolicy | Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. |
LifecyclePolicy | Writes an object lifecycle policy to a container. |
MetricPolicy | The metric policy that is associated with the container. |
Policy | Creates an access policy for the specified container to restrict the users and clients that can access it. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnContainer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnContainer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnContainer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnContainer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnContainer(Construct, String, ICfnContainerProps)
public CfnContainer(Construct scope, string id, ICfnContainerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnContainerProps
Resource properties.
Properties
AccessLoggingEnabled
The state of access logging on the container.
public virtual object AccessLoggingEnabled { get; set; }
Property Value
System.Object
AttrEndpoint
The DNS endpoint of the container.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
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.
CloudformationAttribute: Endpoint
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerName
The name for the container.
public virtual string ContainerName { get; set; }
Property Value
System.String
CorsPolicy
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
public virtual object CorsPolicy { get; set; }
Property Value
System.Object
LifecyclePolicy
Writes an object lifecycle policy to a container.
public virtual string LifecyclePolicy { get; set; }
Property Value
System.String
MetricPolicy
The metric policy that is associated with the container.
public virtual object MetricPolicy { get; set; }
Property Value
System.Object
Policy
Creates an access policy for the specified container to restrict the users and clients that can access it.
public virtual string Policy { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>