Class: AWSCDK::Codepipeline::CfnCustomActionType::SettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/cfn_custom_action_type.rb

Overview

Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entity_url_template: nil, execution_url_template: nil, revision_url_template: nil, third_party_configuration_url: nil) ⇒ SettingsProperty

Returns a new instance of SettingsProperty.

Parameters:

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

    The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group.

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

    The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy.

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

    The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

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

    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.



753
754
755
756
757
758
759
760
761
762
 
# File 'codepipeline/cfn_custom_action_type.rb', line 753

def initialize(entity_url_template: nil, execution_url_template: nil, revision_url_template: nil, third_party_configuration_url: nil)
  @entity_url_template = entity_url_template
  Jsii::Type.check_type(@entity_url_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityUrlTemplate") unless @entity_url_template.nil?
  @execution_url_template = execution_url_template
  Jsii::Type.check_type(@execution_url_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionUrlTemplate") unless @execution_url_template.nil?
  @revision_url_template = revision_url_template
  Jsii::Type.check_type(@revision_url_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "revisionUrlTemplate") unless @revision_url_template.nil?
  @third_party_configuration_url = third_party_configuration_url
  Jsii::Type.check_type(@third_party_configuration_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thirdPartyConfigurationUrl") unless @third_party_configuration_url.nil?
end

Instance Attribute Details

#entity_url_template ⇒ String? (readonly)

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group.

This link is provided as part of the action display in the pipeline.

Returns:

  • (String, nil)

See Also:



770
771
772
 
# File 'codepipeline/cfn_custom_action_type.rb', line 770

def entity_url_template
  @entity_url_template
end

#execution_url_template ⇒ String? (readonly)

The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy.

This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

Returns:

  • (String, nil)

See Also:



777
778
779
 
# File 'codepipeline/cfn_custom_action_type.rb', line 777

def execution_url_template
  @execution_url_template
end

#revision_url_template ⇒ String? (readonly)

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

Returns:

  • (String, nil)

See Also:



782
783
784
 
# File 'codepipeline/cfn_custom_action_type.rb', line 782

def revision_url_template
  @revision_url_template
end

#third_party_configuration_url ⇒ String? (readonly)

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

Returns:

  • (String, nil)

See Also:



787
788
789
 
# File 'codepipeline/cfn_custom_action_type.rb', line 787

def third_party_configuration_url
  @third_party_configuration_url
end

Class Method Details

.jsii_properties ⇒ Object 



789
790
791
792
793
794
795
796
 
# File 'codepipeline/cfn_custom_action_type.rb', line 789

def self.jsii_properties
  {
    :entity_url_template => "entityUrlTemplate",
    :execution_url_template => "executionUrlTemplate",
    :revision_url_template => "revisionUrlTemplate",
    :third_party_configuration_url => "thirdPartyConfigurationUrl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



798
799
800
801
802
803
804
805
806
807
 
# File 'codepipeline/cfn_custom_action_type.rb', line 798

def to_jsii
  result = {}
  result.merge!({
    "entityUrlTemplate" => @entity_url_template,
    "executionUrlTemplate" => @execution_url_template,
    "revisionUrlTemplate" => @revision_url_template,
    "thirdPartyConfigurationUrl" => @third_party_configuration_url,
  })
  result.compact
end