Class: AWSCDK::CodeArtifact::CfnPackageGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_artifact/cfn_package_group_props.rb

Overview

Properties for defining a CfnPackageGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, pattern:, contact_info: nil, description: nil, domain_owner: nil, origin_configuration: nil, tags: nil) ⇒ CfnPackageGroupProps

Returns a new instance of CfnPackageGroupProps.

Parameters:

  • domain_name (String) —

    The domain that contains the package group.

  • pattern (String) —

    The pattern of the package group.

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

    The contact information of the package group.

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

    The description of the package group.

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

    The 12-digit account number of the AWS account that owns the domain.

  • origin_configuration (AWSCDK::IResolvable, AWSCDK::CodeArtifact::CfnPackageGroup::OriginConfigurationProperty, nil) (defaults to: nil) —

    Details about the package origin configuration of a package group.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to the package group.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'code_artifact/cfn_package_group_props.rb', line 16

def initialize(domain_name:, pattern:, contact_info: nil, description: nil, domain_owner: nil, origin_configuration: nil, tags: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @pattern = pattern
  Jsii::Type.check_type(@pattern, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pattern")
  @contact_info = contact_info
  Jsii::Type.check_type(@contact_info, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contactInfo") unless @contact_info.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @domain_owner = domain_owner
  Jsii::Type.check_type(@domain_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainOwner") unless @domain_owner.nil?
  @origin_configuration = origin_configuration.is_a?(Hash) ? ::AWSCDK::CodeArtifact::CfnPackageGroup::OriginConfigurationProperty.new(**origin_configuration.transform_keys(&:to_sym)) : origin_configuration
  Jsii::Type.check_type(@origin_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYXJ0aWZhY3QuQ2ZuUGFja2FnZUdyb3VwLk9yaWdpbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "originConfiguration") unless @origin_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#contact_info ⇒ String? (readonly)

The contact information of the package group.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'code_artifact/cfn_package_group_props.rb', line 49

def contact_info
  @contact_info
end

#description ⇒ String? (readonly)

The description of the package group.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'code_artifact/cfn_package_group_props.rb', line 54

def description
  @description
end

#domain_name ⇒ String (readonly)

The domain that contains the package group.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'code_artifact/cfn_package_group_props.rb', line 37

def domain_name
  @domain_name
end

#domain_owner ⇒ String? (readonly)

The 12-digit account number of the AWS account that owns the domain.

It does not include dashes or spaces.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'code_artifact/cfn_package_group_props.rb', line 61

def domain_owner
  @domain_owner
end

#origin_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Details about the package origin configuration of a package group.

Returns:

See Also:



66
67
68
 
# File 'code_artifact/cfn_package_group_props.rb', line 66

def origin_configuration
  @origin_configuration
end

#pattern ⇒ String (readonly)

The pattern of the package group.

The pattern determines which packages are associated with the package group.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'code_artifact/cfn_package_group_props.rb', line 44

def pattern
  @pattern
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to the package group.

Returns:

See Also:



71
72
73
 
# File 'code_artifact/cfn_package_group_props.rb', line 71

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'code_artifact/cfn_package_group_props.rb', line 73

def self.jsii_properties
  {
    :domain_name => "domainName",
    :pattern => "pattern",
    :contact_info => "contactInfo",
    :description => "description",
    :domain_owner => "domainOwner",
    :origin_configuration => "originConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'code_artifact/cfn_package_group_props.rb', line 85

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "pattern" => @pattern,
    "contactInfo" => @contact_info,
    "description" => @description,
    "domainOwner" => @domain_owner,
    "originConfiguration" => @origin_configuration,
    "tags" => @tags,
  })
  result.compact
end