Class: AWSCDK::CloudFormation::CfnPublicTypeVersionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_formation/cfn_public_type_version_props.rb

Overview

Properties for defining a CfnPublicTypeVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn: nil, log_delivery_bucket: nil, public_version_number: nil, type: nil, type_name: nil) ⇒ CfnPublicTypeVersionProps

Returns a new instance of CfnPublicTypeVersionProps.

Parameters:

  • arn (String, nil) (defaults to: nil) —

    The Amazon Resource Number (ARN) of the extension.

  • log_delivery_bucket (String, nil) (defaults to: nil) —

    The S3 bucket to which CloudFormation delivers the contract test execution logs.

  • public_version_number (String, nil) (defaults to: nil) —

    The version number to assign to this version of the extension.

  • type (String, nil) (defaults to: nil) —

    The type of the extension to test.

  • type_name (String, nil) (defaults to: nil) —

    The name of the extension to test.



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

def initialize(arn: nil, log_delivery_bucket: nil, public_version_number: nil, type: nil, type_name: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") unless @arn.nil?
  @log_delivery_bucket = log_delivery_bucket
  Jsii::Type.check_type(@log_delivery_bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logDeliveryBucket") unless @log_delivery_bucket.nil?
  @public_version_number = public_version_number
  Jsii::Type.check_type(@public_version_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publicVersionNumber") unless @public_version_number.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
  @type_name = type_name
  Jsii::Type.check_type(@type_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeName") unless @type_name.nil?
end

Instance Attribute Details

#arn ⇒ String? (readonly)

The Amazon Resource Number (ARN) of the extension.

Conditional: You must specify Arn , or TypeName and Type .

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 33

def arn
  @arn
end

#log_delivery_bucket ⇒ String? (readonly)

The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED .

The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

  • s3:GetObject
  • s3:PutObject

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 45

def log_delivery_bucket
  @log_delivery_bucket
end

#public_version_number ⇒ String? (readonly)

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0 .

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0 .

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 60

def public_version_number
  @public_version_number
end

#type ⇒ String? (readonly)

The type of the extension to test.

Conditional: You must specify Arn , or TypeName and Type .

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 67

def type
  @type
end

#type_name ⇒ String? (readonly)

The name of the extension to test.

Conditional: You must specify Arn , or TypeName and Type .

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 74

def type_name
  @type_name
end

Class Method Details

.jsii_properties ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 76

def self.jsii_properties
  {
    :arn => "arn",
    :log_delivery_bucket => "logDeliveryBucket",
    :public_version_number => "publicVersionNumber",
    :type => "type",
    :type_name => "typeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
 
# File 'cloud_formation/cfn_public_type_version_props.rb', line 86

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "logDeliveryBucket" => @log_delivery_bucket,
    "publicVersionNumber" => @public_version_number,
    "type" => @type,
    "typeName" => @type_name,
  })
  result.compact
end