Show / Hide Table of Contents

Class CfnTemplatePropsMixin

Creates a template in the Cases domain.

Inheritance
object
Mixin
CfnTemplatePropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.Cases.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnTemplatePropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnTemplatePropsMixin Inherits Mixin Implements IMixin
Remarks

This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Other template APIs are:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

    CloudformationResource: AWS::Cases::Template

    Mixin: true

    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.Mixins.Preview.Mixins;
                 using Amazon.CDK.Mixins.Preview.AWS.Cases.Mixins;
    
                 var cfnTemplatePropsMixin = new CfnTemplatePropsMixin(new CfnTemplateMixinProps {
                     Description = "description",
                     DomainId = "domainId",
                     LayoutConfiguration = new LayoutConfigurationProperty {
                         DefaultLayout = "defaultLayout"
                     },
                     Name = "name",
                     RequiredFields = new [] { new RequiredFieldProperty {
                         FieldId = "fieldId"
                     } },
                     Rules = new [] { new TemplateRuleProperty {
                         CaseRuleId = "caseRuleId",
                         FieldId = "fieldId"
                     } },
                     Status = "status",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 }, new CfnPropertyMixinOptions {
                     Strategy = PropertyMergeStrategy.OVERRIDE
                 });

    Synopsis

    Constructors

    CfnTemplatePropsMixin(ICfnTemplateMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::Cases::Template.

    Properties

    CFN_PROPERTY_KEYS

    Creates a template in the Cases domain.

    Props

    Creates a template in the Cases domain.

    Strategy

    Creates a template in the Cases domain.

    Methods

    ApplyTo(IConstruct)

    Apply the mixin properties to the construct.

    Supports(IConstruct)

    Check if this mixin supports the given construct.

    Constructors

    CfnTemplatePropsMixin(ICfnTemplateMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::Cases::Template.

    public CfnTemplatePropsMixin(ICfnTemplateMixinProps props, ICfnPropertyMixinOptions? options = null)
    Parameters
    props ICfnTemplateMixinProps

    L1 properties to apply.

    options ICfnPropertyMixinOptions

    Mixin options.

    Remarks

    This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

    Other template APIs are:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

      CloudformationResource: AWS::Cases::Template

      Mixin: true

      ExampleMetadata: fixture=_generated

      Properties

      CFN_PROPERTY_KEYS

      Creates a template in the Cases domain.

      protected static string[] CFN_PROPERTY_KEYS { get; }
      Property Value

      string[]

      Remarks

      This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

      Other template APIs are:

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

        CloudformationResource: AWS::Cases::Template

        Mixin: true

        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.Mixins.Preview.Mixins;
                     using Amazon.CDK.Mixins.Preview.AWS.Cases.Mixins;
        
                     var cfnTemplatePropsMixin = new CfnTemplatePropsMixin(new CfnTemplateMixinProps {
                         Description = "description",
                         DomainId = "domainId",
                         LayoutConfiguration = new LayoutConfigurationProperty {
                             DefaultLayout = "defaultLayout"
                         },
                         Name = "name",
                         RequiredFields = new [] { new RequiredFieldProperty {
                             FieldId = "fieldId"
                         } },
                         Rules = new [] { new TemplateRuleProperty {
                             CaseRuleId = "caseRuleId",
                             FieldId = "fieldId"
                         } },
                         Status = "status",
                         Tags = new [] { new CfnTag {
                             Key = "key",
                             Value = "value"
                         } }
                     }, new CfnPropertyMixinOptions {
                         Strategy = PropertyMergeStrategy.OVERRIDE
                     });

        Props

        Creates a template in the Cases domain.

        protected virtual ICfnTemplateMixinProps Props { get; }
        Property Value

        ICfnTemplateMixinProps

        Remarks

        This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

        Other template APIs are:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

          CloudformationResource: AWS::Cases::Template

          Mixin: true

          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.Mixins.Preview.Mixins;
                       using Amazon.CDK.Mixins.Preview.AWS.Cases.Mixins;
          
                       var cfnTemplatePropsMixin = new CfnTemplatePropsMixin(new CfnTemplateMixinProps {
                           Description = "description",
                           DomainId = "domainId",
                           LayoutConfiguration = new LayoutConfigurationProperty {
                               DefaultLayout = "defaultLayout"
                           },
                           Name = "name",
                           RequiredFields = new [] { new RequiredFieldProperty {
                               FieldId = "fieldId"
                           } },
                           Rules = new [] { new TemplateRuleProperty {
                               CaseRuleId = "caseRuleId",
                               FieldId = "fieldId"
                           } },
                           Status = "status",
                           Tags = new [] { new CfnTag {
                               Key = "key",
                               Value = "value"
                           } }
                       }, new CfnPropertyMixinOptions {
                           Strategy = PropertyMergeStrategy.OVERRIDE
                       });

          Strategy

          Creates a template in the Cases domain.

          protected virtual PropertyMergeStrategy Strategy { get; }
          Property Value

          PropertyMergeStrategy

          Remarks

          This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

          Other template APIs are:

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

            CloudformationResource: AWS::Cases::Template

            Mixin: true

            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.Mixins.Preview.Mixins;
                         using Amazon.CDK.Mixins.Preview.AWS.Cases.Mixins;
            
                         var cfnTemplatePropsMixin = new CfnTemplatePropsMixin(new CfnTemplateMixinProps {
                             Description = "description",
                             DomainId = "domainId",
                             LayoutConfiguration = new LayoutConfigurationProperty {
                                 DefaultLayout = "defaultLayout"
                             },
                             Name = "name",
                             RequiredFields = new [] { new RequiredFieldProperty {
                                 FieldId = "fieldId"
                             } },
                             Rules = new [] { new TemplateRuleProperty {
                                 CaseRuleId = "caseRuleId",
                                 FieldId = "fieldId"
                             } },
                             Status = "status",
                             Tags = new [] { new CfnTag {
                                 Key = "key",
                                 Value = "value"
                             } }
                         }, new CfnPropertyMixinOptions {
                             Strategy = PropertyMergeStrategy.OVERRIDE
                         });

            Methods

            ApplyTo(IConstruct)

            Apply the mixin properties to the construct.

            public override void ApplyTo(IConstruct construct)
            Parameters
            construct IConstruct
            Overrides
            Mixin.ApplyTo(IConstruct)
            Remarks

            This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

            Other template APIs are:

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

              CloudformationResource: AWS::Cases::Template

              Mixin: true

              ExampleMetadata: fixture=_generated

              Supports(IConstruct)

              Check if this mixin supports the given construct.

              public override bool Supports(IConstruct construct)
              Parameters
              construct IConstruct
              Returns

              bool

              Overrides
              Mixin.Supports(IConstruct)
              Remarks

              This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

              Other template APIs are:

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html

                CloudformationResource: AWS::Cases::Template

                Mixin: true

                ExampleMetadata: fixture=_generated

                Implements

                Constructs.IMixin
                Back to top Generated by DocFX