Skip to content

Latest commit

 

History

History
253 lines (156 loc) · 8.29 KB

cloudbuildv2_repository.md

File metadata and controls

253 lines (156 loc) · 8.29 KB
Raw
permalink
/cloudbuildv2_repository/

cloudbuildv2_repository

cloudbuildv2_repository represents the google_cloudbuildv2_repository Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

Fields

fn new

new()

google.cloudbuildv2_repository.new injects a new google_cloudbuildv2_repository Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.cloudbuildv2_repository.new('some_id')

You can get the reference to the id field of the created google.cloudbuildv2_repository using the reference:

$._ref.google_cloudbuildv2_repository.some_id.get('id')

This is the same as directly entering "${ google_cloudbuildv2_repository.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

  • resourceLabel (string): The name label of the block.
  • annotations (obj): Allows clients to store small amounts of arbitrary data. When null, the annotations field will be omitted from the resulting object.
  • location (string): The location for the resource When null, the location field will be omitted from the resulting object.
  • name (string): Name of the repository.
  • parent_connection (string): The connection for the resource
  • project (string): The project for the resource When null, the project field will be omitted from the resulting object.
  • remote_uri (string): Required. Git Clone HTTPS URI.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloudbuildv2_repository.timeouts.new constructor.

Returns:

  • A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.cloudbuildv2_repository.newAttrs constructs a new object with attributes and blocks configured for the cloudbuildv2_repository Terraform resource.

Unlike google.cloudbuildv2_repository.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

  • annotations (obj): Allows clients to store small amounts of arbitrary data. When null, the annotations field will be omitted from the resulting object.
  • location (string): The location for the resource When null, the location field will be omitted from the resulting object.
  • name (string): Name of the repository.
  • parent_connection (string): The connection for the resource
  • project (string): The project for the resource When null, the project field will be omitted from the resulting object.
  • remote_uri (string): Required. Git Clone HTTPS URI.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloudbuildv2_repository.timeouts.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new cloudbuildv2_repository resource into the root Terraform configuration.

fn withAnnotations

withAnnotations()

google.obj.withAnnotations constructs a mixin object that can be merged into the obj Terraform resource block to set or update the annotations field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the annotations field.

fn withLocation

withLocation()

google.string.withLocation constructs a mixin object that can be merged into the string Terraform resource block to set or update the location field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the location field.

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the name field.

fn withParentConnection

withParentConnection()

google.string.withParentConnection constructs a mixin object that can be merged into the string Terraform resource block to set or update the parent_connection field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the parent_connection field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the project field.

fn withRemoteUri

withRemoteUri()

google.string.withRemoteUri constructs a mixin object that can be merged into the string Terraform resource block to set or update the remote_uri field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the remote_uri field.

fn withTimeouts

withTimeouts()

google.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the google.obj.withTimeoutsMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

google.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the google.obj.withTimeouts function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

obj timeouts

fn timeouts.new

new()

google.cloudbuildv2_repository.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
  • delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.