Class: AWSCDK::CodeStarConnections::CfnSyncConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_star_connections/cfn_sync_configuration_props.rb

Overview

Properties for defining a CfnSyncConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(branch:, config_file:, repository_link_id:, resource_name:, role_arn:, sync_type:, publish_deployment_status: nil, trigger_resource_update_on: nil) ⇒ CfnSyncConfigurationProps

Returns a new instance of CfnSyncConfigurationProps.

Parameters:

  • branch (String) —

    The branch associated with a specific sync configuration.

  • config_file (String) —

    The file path to the configuration file associated with a specific sync configuration.

  • repository_link_id (String) —

    The ID of the repository link associated with a specific sync configuration.

  • resource_name (String) —

    The name of the connection resource associated with a specific sync configuration.

  • role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

  • sync_type (String) —

    The type of sync for a specific sync configuration.

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

    Whether to enable or disable publishing of deployment status to source providers.

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

    When to trigger Git sync to begin the stack update.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 17

def initialize(branch:, config_file:, repository_link_id:, resource_name:, role_arn:, sync_type:, publish_deployment_status: nil, trigger_resource_update_on: nil)
  @branch = branch
  Jsii::Type.check_type(@branch, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "branch")
  @config_file = config_file
  Jsii::Type.check_type(@config_file, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configFile")
  @repository_link_id = repository_link_id
  Jsii::Type.check_type(@repository_link_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repositoryLinkId")
  @resource_name = resource_name
  Jsii::Type.check_type(@resource_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @sync_type = sync_type
  Jsii::Type.check_type(@sync_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "syncType")
  @publish_deployment_status = publish_deployment_status
  Jsii::Type.check_type(@publish_deployment_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publishDeploymentStatus") unless @publish_deployment_status.nil?
  @trigger_resource_update_on = trigger_resource_update_on
  Jsii::Type.check_type(@trigger_resource_update_on, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "triggerResourceUpdateOn") unless @trigger_resource_update_on.nil?
end

Instance Attribute Details

#branch ⇒ String (readonly)

The branch associated with a specific sync configuration.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 40

def branch
  @branch
end

#config_file ⇒ String (readonly)

The file path to the configuration file associated with a specific sync configuration.

The path should point to an actual file in the sync configurations linked repository.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 47

def config_file
  @config_file
end

#publish_deployment_status ⇒ String? (readonly)

Whether to enable or disable publishing of deployment status to source providers.

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 72

def publish_deployment_status
  @publish_deployment_status
end

#repository_link_id ⇒ String (readonly)

The ID of the repository link associated with a specific sync configuration.

Returns:

  • (String)

See Also:



52
53
54
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 52

def repository_link_id
  @repository_link_id
end

#resource_name ⇒ String (readonly)

The name of the connection resource associated with a specific sync configuration.

Returns:

  • (String)

See Also:



57
58
59
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 57

def resource_name
  @resource_name
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

Returns:

  • (String)

See Also:



62
63
64
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 62

def role_arn
  @role_arn
end

#sync_type ⇒ String (readonly)

The type of sync for a specific sync configuration.

Returns:

  • (String)

See Also:



67
68
69
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 67

def sync_type
  @sync_type
end

#trigger_resource_update_on ⇒ String? (readonly)

When to trigger Git sync to begin the stack update.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 77

def trigger_resource_update_on
  @trigger_resource_update_on
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 79

def self.jsii_properties
  {
    :branch => "branch",
    :config_file => "configFile",
    :repository_link_id => "repositoryLinkId",
    :resource_name => "resourceName",
    :role_arn => "roleArn",
    :sync_type => "syncType",
    :publish_deployment_status => "publishDeploymentStatus",
    :trigger_resource_update_on => "triggerResourceUpdateOn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'code_star_connections/cfn_sync_configuration_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "branch" => @branch,
    "configFile" => @config_file,
    "repositoryLinkId" => @repository_link_id,
    "resourceName" => @resource_name,
    "roleArn" => @role_arn,
    "syncType" => @sync_type,
    "publishDeploymentStatus" => @publish_deployment_status,
    "triggerResourceUpdateOn" => @trigger_resource_update_on,
  })
  result.compact
end