Class: AWSCDK::CodeBuild::CfnProject

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCodebuild::IProjectRef
Defined in:
code_build/cfn_project.rb

Overview

The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code.

For example, it tells CodeBuild where to get the source code and which build environment to use.

To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnProject

Create a new AWS::CodeBuild::Project.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CodeBuild::CfnProjectProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'code_build/cfn_project.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProjectProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmblByb2plY3RQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_project(resource) ⇒ String

Parameters:

Returns:

  • (String) 


101
102
103
104
 
# File 'code_build/cfn_project.rb', line 101

def self.arn_for_project(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2RlYnVpbGQuSVByb2plY3RSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.CfnProject", "arnForProject", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


234
235
236
 
# File 'code_build/cfn_project.rb', line 234

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codebuild.CfnProject", "CFN_RESOURCE_TYPE_NAME")
end

.from_project_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSCodebuild::IProjectRef

Creates a new IProjectRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



112
113
114
115
116
117
 
# File 'code_build/cfn_project.rb', line 112

def self.from_project_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.CfnProject", "fromProjectArn", [scope, id, arn])
end

.from_project_name(scope, id, project_name) ⇒ AWSCDK::Interfaces::AWSCodebuild::IProjectRef

Creates a new IProjectRef from a projectName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • project_name (String)

Returns:



125
126
127
128
129
130
 
# File 'code_build/cfn_project.rb', line 125

def self.from_project_name(scope, id, project_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(project_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.CfnProject", "fromProjectName", [scope, id, project_name])
end

.is_cfn_project(x) ⇒ Boolean

Checks whether the given object is a CfnProject.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


136
137
138
139
 
# File 'code_build/cfn_project.rb', line 136

def self.is_cfn_project(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.CfnProject", "isCfnProject", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'code_build/cfn_project.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :project_ref => { kind: :property, name: "projectRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :artifacts => { kind: :property, name: "artifacts", is_optional: false },
    :environment => { kind: :property, name: "environment", is_optional: false },
    :service_role => { kind: :property, name: "serviceRole", is_optional: false },
    :source => { kind: :property, name: "source", is_optional: false },
    :auto_retry_limit => { kind: :property, name: "autoRetryLimit", is_optional: true },
    :badge_enabled => { kind: :property, name: "badgeEnabled", is_optional: true },
    :build_batch_config => { kind: :property, name: "buildBatchConfig", is_optional: true },
    :cache => { kind: :property, name: "cache", is_optional: true },
    :concurrent_build_limit => { kind: :property, name: "concurrentBuildLimit", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_key => { kind: :property, name: "encryptionKey", is_optional: true },
    :file_system_locations => { kind: :property, name: "fileSystemLocations", is_optional: true },
    :logs_config => { kind: :property, name: "logsConfig", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :queued_timeout_in_minutes => { kind: :property, name: "queuedTimeoutInMinutes", is_optional: true },
    :resource_access_role => { kind: :property, name: "resourceAccessRole", is_optional: true },
    :secondary_artifacts => { kind: :property, name: "secondaryArtifacts", is_optional: true },
    :secondary_sources => { kind: :property, name: "secondarySources", is_optional: true },
    :secondary_source_versions => { kind: :property, name: "secondarySourceVersions", is_optional: true },
    :source_version => { kind: :property, name: "sourceVersion", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :timeout_in_minutes => { kind: :property, name: "timeoutInMinutes", is_optional: true },
    :triggers => { kind: :property, name: "triggers", is_optional: true },
    :visibility => { kind: :property, name: "visibility", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



609
610
611
612
 
# File 'code_build/cfn_project.rb', line 609

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



621
622
623
624
 
# File 'code_build/cfn_project.rb', line 621

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



631
632
633
634
 
# File 'code_build/cfn_project.rb', line 631

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



642
643
644
645
646
 
# File 'code_build/cfn_project.rb', line 642

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


699
700
701
702
703
 
# File 'code_build/cfn_project.rb', line 699

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



709
710
711
712
 
# File 'code_build/cfn_project.rb', line 709

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



721
722
723
724
725
 
# File 'code_build/cfn_project.rb', line 721

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



734
735
736
737
 
# File 'code_build/cfn_project.rb', line 734

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



756
757
758
759
760
761
 
# File 'code_build/cfn_project.rb', line 756

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#artifacts ⇒ AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnProject::ArtifactsProperty

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Returns:



267
268
269
 
# File 'code_build/cfn_project.rb', line 267

def artifacts()
  jsii_get_property("artifacts")
end

#artifacts=(value) ⇒ Object 



271
272
273
274
275
 
# File 'code_build/cfn_project.rb', line 271

def artifacts=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::ArtifactsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5BcnRpZmFjdHNQcm9wZXJ0eSJ9XX19")), "artifacts")
  jsii_set_property("artifacts", value)
end

#attr_arn ⇒ String

The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName .

Returns:

  • (String) 


241
242
243
 
# File 'code_build/cfn_project.rb', line 241

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

Returns:

  • (String) 


246
247
248
 
# File 'code_build/cfn_project.rb', line 246

def attr_id()
  jsii_get_property("attrId")
end

#auto_retry_limit ⇒ Numeric?

Returns:

  • (Numeric, nil) 


316
317
318
 
# File 'code_build/cfn_project.rb', line 316

def auto_retry_limit()
  jsii_get_property("autoRetryLimit")
end

#auto_retry_limit=(value) ⇒ Object 



320
321
322
323
 
# File 'code_build/cfn_project.rb', line 320

def auto_retry_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "autoRetryLimit") unless value.nil?
  jsii_set_property("autoRetryLimit", value)
end

#badge_enabled ⇒ Boolean, ...

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

Returns:



328
329
330
 
# File 'code_build/cfn_project.rb', line 328

def badge_enabled()
  jsii_get_property("badgeEnabled")
end

#badge_enabled=(value) ⇒ Object 



332
333
334
335
 
# File 'code_build/cfn_project.rb', line 332

def badge_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "badgeEnabled") unless value.nil?
  jsii_set_property("badgeEnabled", value)
end

#build_batch_config ⇒ AWSCDK::IResolvable, ...

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Returns:



340
341
342
 
# File 'code_build/cfn_project.rb', line 340

def build_batch_config()
  jsii_get_property("buildBatchConfig")
end

#build_batch_config=(value) ⇒ Object 



344
345
346
347
348
 
# File 'code_build/cfn_project.rb', line 344

def build_batch_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::ProjectBuildBatchConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5Qcm9qZWN0QnVpbGRCYXRjaENvbmZpZ1Byb3BlcnR5In1dfX0=")), "buildBatchConfig") unless value.nil?
  jsii_set_property("buildBatchConfig", value)
end

#cache ⇒ AWSCDK::IResolvable, ...

Settings that AWS CodeBuild uses to store and reuse build dependencies.

Returns:



353
354
355
 
# File 'code_build/cfn_project.rb', line 353

def cache()
  jsii_get_property("cache")
end

#cache=(value) ⇒ Object 



357
358
359
360
361
 
# File 'code_build/cfn_project.rb', line 357

def cache=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::ProjectCacheProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5Qcm9qZWN0Q2FjaGVQcm9wZXJ0eSJ9XX19")), "cache") unless value.nil?
  jsii_set_property("cache", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



187
188
189
 
# File 'code_build/cfn_project.rb', line 187

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'code_build/cfn_project.rb', line 192

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


765
766
767
768
 
# File 'code_build/cfn_project.rb', line 765

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


197
198
199
 
# File 'code_build/cfn_project.rb', line 197

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


204
205
206
 
# File 'code_build/cfn_project.rb', line 204

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#concurrent_build_limit ⇒ Numeric?

The maximum number of concurrent builds that are allowed for this project.

Returns:

  • (Numeric, nil) 


366
367
368
 
# File 'code_build/cfn_project.rb', line 366

def concurrent_build_limit()
  jsii_get_property("concurrentBuildLimit")
end

#concurrent_build_limit=(value) ⇒ Object 



370
371
372
373
 
# File 'code_build/cfn_project.rb', line 370

def concurrent_build_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "concurrentBuildLimit") unless value.nil?
  jsii_set_property("concurrentBuildLimit", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


149
150
151
 
# File 'code_build/cfn_project.rb', line 149

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description that makes the build project easy to identify.

Returns:

  • (String, nil) 


378
379
380
 
# File 'code_build/cfn_project.rb', line 378

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



382
383
384
385
 
# File 'code_build/cfn_project.rb', line 382

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#encryption_key ⇒ String?

The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

Returns:

  • (String, nil) 


390
391
392
 
# File 'code_build/cfn_project.rb', line 390

def encryption_key()
  jsii_get_property("encryptionKey")
end

#encryption_key=(value) ⇒ Object 



394
395
396
397
 
# File 'code_build/cfn_project.rb', line 394

def encryption_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKey") unless value.nil?
  jsii_set_property("encryptionKey", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



209
210
211
 
# File 'code_build/cfn_project.rb', line 209

def env()
  jsii_get_property("env")
end

#environment ⇒ AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnProject::EnvironmentProperty

The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

Returns:



280
281
282
 
# File 'code_build/cfn_project.rb', line 280

def environment()
  jsii_get_property("environment")
end

#environment=(value) ⇒ Object 



284
285
286
287
288
 
# File 'code_build/cfn_project.rb', line 284

def environment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::EnvironmentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5FbnZpcm9ubWVudFByb3BlcnR5In1dfX0=")), "environment")
  jsii_set_property("environment", value)
end

#file_system_locations ⇒ AWSCDK::IResolvable, ...

An array of ProjectFileSystemLocation objects for a CodeBuild build project.

Returns:



402
403
404
 
# File 'code_build/cfn_project.rb', line 402

def file_system_locations()
  jsii_get_property("fileSystemLocations")
end

#file_system_locations=(value) ⇒ Object 



406
407
408
409
 
# File 'code_build/cfn_project.rb', line 406

def file_system_locations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmblByb2plY3QuUHJvamVjdEZpbGVTeXN0ZW1Mb2NhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "fileSystemLocations") unless value.nil?
  jsii_set_property("fileSystemLocations", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



778
779
780
781
782
 
# File 'code_build/cfn_project.rb', line 778

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



789
790
791
792
 
# File 'code_build/cfn_project.rb', line 789

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



859
860
861
862
 
# File 'code_build/cfn_project.rb', line 859

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


161
162
163
 
# File 'code_build/cfn_project.rb', line 161

def logical_id()
  jsii_get_property("logicalId")
end

#logs_config ⇒ AWSCDK::IResolvable, ...

Information about logs for the build project.

Returns:



414
415
416
 
# File 'code_build/cfn_project.rb', line 414

def logs_config()
  jsii_get_property("logsConfig")
end

#logs_config=(value) ⇒ Object 



418
419
420
421
422
 
# File 'code_build/cfn_project.rb', line 418

def logs_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::LogsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5Mb2dzQ29uZmlnUHJvcGVydHkifV19fQ==")), "logsConfig") unless value.nil?
  jsii_set_property("logsConfig", value)
end

#name ⇒ String?

The name of the build project.

Returns:

  • (String, nil) 


427
428
429
 
# File 'code_build/cfn_project.rb', line 427

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



431
432
433
434
 
# File 'code_build/cfn_project.rb', line 431

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


144
145
146
 
# File 'code_build/cfn_project.rb', line 144

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



800
801
802
 
# File 'code_build/cfn_project.rb', line 800

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



807
808
809
 
# File 'code_build/cfn_project.rb', line 807

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



600
601
602
603
 
# File 'code_build/cfn_project.rb', line 600

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#project_ref ⇒ AWSCDK::Interfaces::AWSCodebuild::ProjectReference

A reference to a Project resource.

Returns:



253
254
255
 
# File 'code_build/cfn_project.rb', line 253

def project_ref()
  jsii_get_property("projectRef")
end

#queued_timeout_in_minutes ⇒ Numeric?

The number of minutes a build is allowed to be queued before it times out.

Returns:

  • (Numeric, nil) 


439
440
441
 
# File 'code_build/cfn_project.rb', line 439

def queued_timeout_in_minutes()
  jsii_get_property("queuedTimeoutInMinutes")
end

#queued_timeout_in_minutes=(value) ⇒ Object 



443
444
445
446
 
# File 'code_build/cfn_project.rb', line 443

def queued_timeout_in_minutes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "queuedTimeoutInMinutes") unless value.nil?
  jsii_set_property("queuedTimeoutInMinutes", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


180
181
182
 
# File 'code_build/cfn_project.rb', line 180

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



818
819
820
821
 
# File 'code_build/cfn_project.rb', line 818

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


825
826
827
828
 
# File 'code_build/cfn_project.rb', line 825

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



835
836
837
838
839
 
# File 'code_build/cfn_project.rb', line 835

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resource_access_role ⇒ String?

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Returns:

  • (String, nil) 


451
452
453
 
# File 'code_build/cfn_project.rb', line 451

def resource_access_role()
  jsii_get_property("resourceAccessRole")
end

#resource_access_role=(value) ⇒ Object 



455
456
457
458
 
# File 'code_build/cfn_project.rb', line 455

def resource_access_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceAccessRole") unless value.nil?
  jsii_set_property("resourceAccessRole", value)
end

#secondary_artifacts ⇒ AWSCDK::IResolvable, ...

A list of Artifacts objects.

Returns:



463
464
465
 
# File 'code_build/cfn_project.rb', line 463

def secondary_artifacts()
  jsii_get_property("secondaryArtifacts")
end

#secondary_artifacts=(value) ⇒ Object 



467
468
469
470
 
# File 'code_build/cfn_project.rb', line 467

def secondary_artifacts=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmblByb2plY3QuQXJ0aWZhY3RzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "secondaryArtifacts") unless value.nil?
  jsii_set_property("secondaryArtifacts", value)
end

#secondary_source_versions ⇒ AWSCDK::IResolvable, ...

An array of ProjectSourceVersion objects.

Returns:



487
488
489
 
# File 'code_build/cfn_project.rb', line 487

def secondary_source_versions()
  jsii_get_property("secondarySourceVersions")
end

#secondary_source_versions=(value) ⇒ Object 



491
492
493
494
 
# File 'code_build/cfn_project.rb', line 491

def secondary_source_versions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmblByb2plY3QuUHJvamVjdFNvdXJjZVZlcnNpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "secondarySourceVersions") unless value.nil?
  jsii_set_property("secondarySourceVersions", value)
end

#secondary_sources ⇒ AWSCDK::IResolvable, ...

An array of ProjectSource objects.

Returns:



475
476
477
 
# File 'code_build/cfn_project.rb', line 475

def secondary_sources()
  jsii_get_property("secondarySources")
end

#secondary_sources=(value) ⇒ Object 



479
480
481
482
 
# File 'code_build/cfn_project.rb', line 479

def secondary_sources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmblByb2plY3QuU291cmNlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "secondarySources") unless value.nil?
  jsii_set_property("secondarySources", value)
end

#service_role ⇒ String

The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Returns:

  • (String) 


293
294
295
 
# File 'code_build/cfn_project.rb', line 293

def service_role()
  jsii_get_property("serviceRole")
end

#service_role=(value) ⇒ Object 



297
298
299
300
 
# File 'code_build/cfn_project.rb', line 297

def service_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRole")
  jsii_set_property("serviceRole", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



844
845
846
 
# File 'code_build/cfn_project.rb', line 844

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source ⇒ AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnProject::SourceProperty

The source code settings for the project, such as the source code's repository type and location.

Returns:



305
306
307
 
# File 'code_build/cfn_project.rb', line 305

def source()
  jsii_get_property("source")
end

#source=(value) ⇒ Object 



309
310
311
312
313
 
# File 'code_build/cfn_project.rb', line 309

def source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::SourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5Tb3VyY2VQcm9wZXJ0eSJ9XX19")), "source")
  jsii_set_property("source", value)
end

#source_version ⇒ String?

A version of the build input to be built for this project.

Returns:

  • (String, nil) 


499
500
501
 
# File 'code_build/cfn_project.rb', line 499

def source_version()
  jsii_get_property("sourceVersion")
end

#source_version=(value) ⇒ Object 



503
504
505
506
 
# File 'code_build/cfn_project.rb', line 503

def source_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceVersion") unless value.nil?
  jsii_set_property("sourceVersion", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



170
171
172
 
# File 'code_build/cfn_project.rb', line 170

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



260
261
262
 
# File 'code_build/cfn_project.rb', line 260

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

Returns:



511
512
513
 
# File 'code_build/cfn_project.rb', line 511

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



515
516
517
518
519
 
# File 'code_build/cfn_project.rb', line 515

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#timeout_in_minutes ⇒ Numeric?

How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

Returns:

  • (Numeric, nil) 


524
525
526
 
# File 'code_build/cfn_project.rb', line 524

def timeout_in_minutes()
  jsii_get_property("timeoutInMinutes")
end

#timeout_in_minutes=(value) ⇒ Object 



528
529
530
531
 
# File 'code_build/cfn_project.rb', line 528

def timeout_in_minutes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInMinutes") unless value.nil?
  jsii_set_property("timeoutInMinutes", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



576
577
578
 
# File 'code_build/cfn_project.rb', line 576

def to_string()
  jsii_call_method("toString", [])
end

#triggers ⇒ AWSCDK::IResolvable, ...

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Returns:



536
537
538
 
# File 'code_build/cfn_project.rb', line 536

def triggers()
  jsii_get_property("triggers")
end

#triggers=(value) ⇒ Object 



540
541
542
543
544
 
# File 'code_build/cfn_project.rb', line 540

def triggers=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::ProjectTriggersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5Qcm9qZWN0VHJpZ2dlcnNQcm9wZXJ0eSJ9XX19")), "triggers") unless value.nil?
  jsii_set_property("triggers", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


217
218
219
 
# File 'code_build/cfn_project.rb', line 217

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


227
228
229
 
# File 'code_build/cfn_project.rb', line 227

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


850
851
852
853
 
# File 'code_build/cfn_project.rb', line 850

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#visibility ⇒ String?

Specifies the visibility of the project's builds.

Possible values are:.

Returns:

  • (String, nil) 


551
552
553
 
# File 'code_build/cfn_project.rb', line 551

def visibility()
  jsii_get_property("visibility")
end

#visibility=(value) ⇒ Object 



555
556
557
558
 
# File 'code_build/cfn_project.rb', line 555

def visibility=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless value.nil?
  jsii_set_property("visibility", value)
end

#vpc_config ⇒ AWSCDK::IResolvable, ...

VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

Returns:



563
564
565
 
# File 'code_build/cfn_project.rb', line 563

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



567
568
569
570
571
 
# File 'code_build/cfn_project.rb', line 567

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5WcGNDb25maWdQcm9wZXJ0eSJ9XX19")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


589
590
591
592
593
594
 
# File 'code_build/cfn_project.rb', line 589

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end