Class: AWSCDK::ServiceCatalog::CfnCloudFormationProduct::ProvisioningArtifactPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
service_catalog/cfn_cloud_formation_product.rb

Overview

Information about a provisioning artifact (also known as a version) for a product.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(info:, description: nil, disable_template_validation: nil, name: nil, type: nil) ⇒ ProvisioningArtifactPropertiesProperty

Returns a new instance of ProvisioningArtifactPropertiesProperty.

Parameters:

  • info (Object) —

    Specify the template source with one of the following options, but not both.

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

    The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

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

    If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

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

    The name of the provisioning artifact (for example, v1 v2beta).

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

    The type of provisioning artifact.



789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 789

def initialize(info:, description: nil, disable_template_validation: nil, name: nil, type: nil)
  @info = info
  Jsii::Type.check_type(@info, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "info")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @disable_template_validation = disable_template_validation
  Jsii::Type.check_type(@disable_template_validation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableTemplateValidation") unless @disable_template_validation.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

Returns:

  • (String, nil)

See Also:



819
820
821
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 819

def description
  @description
end

#disable_template_validation ⇒ Boolean, ... (readonly)

If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

Returns:

See Also:



824
825
826
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 824

def disable_template_validation
  @disable_template_validation
end

#info ⇒ Object (readonly)

Specify the template source with one of the following options, but not both.

Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ]

The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId : The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

Returns:

  • (Object)

See Also:



814
815
816
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 814

def info
  @info
end

#name ⇒ String? (readonly)

The name of the provisioning artifact (for example, v1 v2beta).

No spaces are allowed.

Returns:

  • (String, nil)

See Also:



831
832
833
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 831

def name
  @name
end

#type ⇒ String? (readonly)

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
  • TERRAFORM_CLOUD - Terraform Cloud configuration file
  • EXTERNAL - External configuration file

Returns:

  • (String, nil)

See Also:



841
842
843
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 841

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



843
844
845
846
847
848
849
850
851
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 843

def self.jsii_properties
  {
    :info => "info",
    :description => "description",
    :disable_template_validation => "disableTemplateValidation",
    :name => "name",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



853
854
855
856
857
858
859
860
861
862
863
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 853

def to_jsii
  result = {}
  result.merge!({
    "info" => @info,
    "description" => @description,
    "disableTemplateValidation" => @disable_template_validation,
    "name" => @name,
    "type" => @type,
  })
  result.compact
end