Skip to content

Latest commit

 

History

History
198 lines (121 loc) · 6.92 KB

sagemaker_code_repository.md

File metadata and controls

198 lines (121 loc) · 6.92 KB
Raw
permalink
/sagemaker_code_repository/

sagemaker_code_repository

sagemaker_code_repository represents the aws_sagemaker_code_repository Terraform resource.

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

Index

Fields

fn new

new()

aws.sagemaker_code_repository.new injects a new aws_sagemaker_code_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
aws.sagemaker_code_repository.new('some_id')

You can get the reference to the id field of the created aws.sagemaker_code_repository using the reference:

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

This is the same as directly entering "${ aws_sagemaker_code_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.
  • code_repository_name (string): Set the code_repository_name field on the resulting resource block.
  • tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
  • tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
  • git_config (list[obj]): Set the git_config field on the resulting resource block. When null, the git_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_code_repository.git_config.new constructor.

Returns:

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

fn newAttrs

newAttrs()

aws.sagemaker_code_repository.newAttrs constructs a new object with attributes and blocks configured for the sagemaker_code_repository Terraform resource.

Unlike aws.sagemaker_code_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:

  • code_repository_name (string): Set the code_repository_name field on the resulting object.
  • tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
  • tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
  • git_config (list[obj]): Set the git_config field on the resulting object. When null, the git_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_code_repository.git_config.new constructor.

Returns:

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

fn withCodeRepositoryName

withCodeRepositoryName()

aws.string.withCodeRepositoryName constructs a mixin object that can be merged into the string Terraform resource block to set or update the code_repository_name field.

Args:

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

fn withGitConfig

withGitConfig()

aws.list[obj].withGitConfig constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the git_config field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withGitConfigMixin function.

Args:

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

fn withGitConfigMixin

withGitConfigMixin()

aws.list[obj].withGitConfigMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the git_config field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withGitConfig function.

Args:

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

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

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

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

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

obj git_config

fn git_config.new

new()

aws.sagemaker_code_repository.git_config.new constructs a new object with attributes and blocks configured for the git_config Terraform sub block.

Args:

  • branch (string): Set the branch field on the resulting object. When null, the branch field will be omitted from the resulting object.
  • repository_url (string): Set the repository_url field on the resulting object.
  • secret_arn (string): Set the secret_arn field on the resulting object. When null, the secret_arn field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the git_config sub block.