Show / Hide Table of Contents

Class CfnQuotaShare

Creates an AWS Batch quota share.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnQuotaShare
Implements
IInspectable
IQuotaShareRef
IConstruct
IDependable
IEnvironmentAware
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnQuotaShare : CfnResource, IInspectable, IQuotaShareRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnQuotaShare Inherits CfnResource Implements IInspectable, IQuotaShareRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

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.Batch;

             var cfnQuotaShare = new CfnQuotaShare(this, "MyCfnQuotaShare", new CfnQuotaShareProps {
                 CapacityLimits = new [] { new QuotaShareCapacityLimitProperty {
                     CapacityUnit = "capacityUnit",
                     MaxCapacity = 123
                 } },
                 JobQueue = "jobQueue",
                 PreemptionConfiguration = new QuotaSharePreemptionConfigurationProperty {
                     InSharePreemption = "inSharePreemption"
                 },
                 QuotaShareName = "quotaShareName",
                 ResourceSharingConfiguration = new QuotaShareResourceSharingConfigurationProperty {
                     Strategy = "strategy",

                     // the properties below are optional
                     BorrowLimit = 123
                 },

                 // the properties below are optional
                 State = "state",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnQuotaShare(Construct, string, ICfnQuotaShareProps)

Create a new AWS::Batch::QuotaShare.

Properties

AttrQuotaShareArn

Creates an AWS Batch quota share.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CapacityLimits

A list that specifies the quantity and type of compute capacity allocated to the quota share.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

Creates an AWS Batch quota share.

CfnPropertyNames

Creates an AWS Batch quota share.

JobQueue

The AWS Batch job queue associated with the quota share.

PreemptionConfiguration

Creates an AWS Batch quota share.

QuotaShareName

The name of the quota share.

QuotaShareRef

A reference to a QuotaShare resource.

ResourceSharingConfiguration

Creates an AWS Batch quota share.

State

The state of the quota share.

Tags

The tags that you apply to the quota share to help you categorize and organize your resources.

Methods

ArnForQuotaShare(IQuotaShareRef)

Creates an AWS Batch quota share.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnQuotaShare(object)

Checks whether the given object is a CfnQuotaShare.

RenderProperties(IDictionary<string, object>)

Creates an AWS Batch quota share.

Constructors

CfnQuotaShare(Construct, string, ICfnQuotaShareProps)

Create a new AWS::Batch::QuotaShare.

public CfnQuotaShare(Construct scope, string id, ICfnQuotaShareProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnQuotaShareProps

Resource properties.

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

Properties

AttrQuotaShareArn

Creates an AWS Batch quota share.

public virtual string AttrQuotaShareArn { get; }
Property Value

string

Remarks

CloudformationAttribute: QuotaShareArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

CapacityLimits

A list that specifies the quantity and type of compute capacity allocated to the quota share.

public virtual object CapacityLimits { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnQuotaShare.IQuotaShareCapacityLimitProperty)[]

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

CfnProperties

Creates an AWS Batch quota share.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates an AWS Batch quota share.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

JobQueue

The AWS Batch job queue associated with the quota share.

public virtual string JobQueue { get; set; }
Property Value

string

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

PreemptionConfiguration

Creates an AWS Batch quota share.

public virtual object PreemptionConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnQuotaShare.IQuotaSharePreemptionConfigurationProperty

QuotaShareName

The name of the quota share.

public virtual string QuotaShareName { get; set; }
Property Value

string

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

QuotaShareRef

A reference to a QuotaShare resource.

public virtual IQuotaShareReference QuotaShareRef { get; }
Property Value

IQuotaShareReference

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

ResourceSharingConfiguration

Creates an AWS Batch quota share.

public virtual object ResourceSharingConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnQuotaShare.IQuotaShareResourceSharingConfigurationProperty

State

The state of the quota share.

public virtual string? State { get; set; }
Property Value

string

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

Tags

The tags that you apply to the quota share to help you categorize and organize your resources.

public virtual IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

Methods

ArnForQuotaShare(IQuotaShareRef)

Creates an AWS Batch quota share.

public static string ArnForQuotaShare(IQuotaShareRef resource)
Parameters
resource IQuotaShareRef
Returns

string

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

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.Batch;

             var cfnQuotaShare = new CfnQuotaShare(this, "MyCfnQuotaShare", new CfnQuotaShareProps {
                 CapacityLimits = new [] { new QuotaShareCapacityLimitProperty {
                     CapacityUnit = "capacityUnit",
                     MaxCapacity = 123
                 } },
                 JobQueue = "jobQueue",
                 PreemptionConfiguration = new QuotaSharePreemptionConfigurationProperty {
                     InSharePreemption = "inSharePreemption"
                 },
                 QuotaShareName = "quotaShareName",
                 ResourceSharingConfiguration = new QuotaShareResourceSharingConfigurationProperty {
                     Strategy = "strategy",

                     // the properties below are optional
                     BorrowLimit = 123
                 },

                 // the properties below are optional
                 State = "state",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

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.

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

IsCfnQuotaShare(object)

Checks whether the given object is a CfnQuotaShare.

public static bool IsCfnQuotaShare(object x)
Parameters
x object
Returns

bool

Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an AWS Batch quota share.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

CloudformationResource: AWS::Batch::QuotaShare

ExampleMetadata: fixture=_generated

Implements

IInspectable
IQuotaShareRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggableV2
Back to top Generated by DocFX