Class: AWSCDK::PCAConnectorAD::CfnTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pca_connector_ad/cfn_template_props.rb

Overview

Properties for defining a CfnTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connector_arn:, definition:, name:, reenroll_all_certificate_holders: nil, tags: nil) ⇒ CfnTemplateProps

Returns a new instance of CfnTemplateProps.

Parameters:

  • connector_arn (String) —

    The Amazon Resource Name (ARN) that was returned when you called CreateConnector .

  • definition (AWSCDK::IResolvable, AWSCDK::PCAConnectorAD::CfnTemplate::TemplateDefinitionProperty) —

    Template configuration to define the information included in certificates.

  • name (String) —

    Name of the templates.

  • reenroll_all_certificate_holders (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    This setting allows the major version of a template to be increased automatically.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Metadata assigned to a template consisting of a key-value pair.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'pca_connector_ad/cfn_template_props.rb', line 14

def initialize(connector_arn:, definition:, name:, reenroll_all_certificate_holders: nil, tags: nil)
  @connector_arn = connector_arn
  Jsii::Type.check_type(@connector_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorArn")
  @definition = definition.is_a?(Hash) ? ::AWSCDK::PCAConnectorAD::CfnTemplate::TemplateDefinitionProperty.new(**definition.transform_keys(&:to_sym)) : definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY2Fjb25uZWN0b3JhZC5DZm5UZW1wbGF0ZS5UZW1wbGF0ZURlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "definition")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @reenroll_all_certificate_holders = reenroll_all_certificate_holders
  Jsii::Type.check_type(@reenroll_all_certificate_holders, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "reenrollAllCertificateHolders") unless @reenroll_all_certificate_holders.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#connector_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) that was returned when you called CreateConnector .

Returns:

  • (String)

See Also:



31
32
33
 
# File 'pca_connector_ad/cfn_template_props.rb', line 31

def connector_arn
  @connector_arn
end

#definition ⇒ AWSCDK::IResolvable, AWSCDK::PCAConnectorAD::CfnTemplate::TemplateDefinitionProperty (readonly)

Template configuration to define the information included in certificates.

Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

Returns:

See Also:



38
39
40
 
# File 'pca_connector_ad/cfn_template_props.rb', line 38

def definition
  @definition
end

#name ⇒ String (readonly)

Name of the templates.

Template names must be unique.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'pca_connector_ad/cfn_template_props.rb', line 45

def name
  @name
end

#reenroll_all_certificate_holders ⇒ Boolean, ... (readonly)

This setting allows the major version of a template to be increased automatically.

All members of Active Directory groups that are allowed to enroll with a template will receive a new certificate issued using that template.

Returns:

See Also:



52
53
54
 
# File 'pca_connector_ad/cfn_template_props.rb', line 52

def reenroll_all_certificate_holders
  @reenroll_all_certificate_holders
end

#tags ⇒ Hash{String => String}? (readonly)

Metadata assigned to a template consisting of a key-value pair.

Returns:

  • (Hash{String => String}, nil)

See Also:



57
58
59
 
# File 'pca_connector_ad/cfn_template_props.rb', line 57

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'pca_connector_ad/cfn_template_props.rb', line 59

def self.jsii_properties
  {
    :connector_arn => "connectorArn",
    :definition => "definition",
    :name => "name",
    :reenroll_all_certificate_holders => "reenrollAllCertificateHolders",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'pca_connector_ad/cfn_template_props.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "connectorArn" => @connector_arn,
    "definition" => @definition,
    "name" => @name,
    "reenrollAllCertificateHolders" => @reenroll_all_certificate_holders,
    "tags" => @tags,
  })
  result.compact
end