datasync_agent.md

permalink
/datasync_agent/

datasync_agent

datasync_agent represents the aws_datasync_agent Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withActivationKey()
• fn withIpAddress()
• fn withName()
• fn withPrivateLinkEndpoint()
• fn withSecurityGroupArns()
• fn withSubnetArns()
• fn withTags()
• fn withTagsAll()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withVpcEndpointId()
• obj timeouts
  • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_datasync_agent.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.
• activation_key (string): Set the activation_key field on the resulting resource block. When null, the activation_key field will be omitted from the resulting object.
• ip_address (string): Set the ip_address field on the resulting resource block. When null, the ip_address field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block. When null, the name field will be omitted from the resulting object.
• private_link_endpoint (string): Set the private_link_endpoint field on the resulting resource block. When null, the private_link_endpoint field will be omitted from the resulting object.
• security_group_arns (list): Set the security_group_arns field on the resulting resource block. When null, the security_group_arns field will be omitted from the resulting object.
• subnet_arns (list): Set the subnet_arns field on the resulting resource block. When null, the subnet_arns field will be omitted from the resulting object.
• 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.
• vpc_endpoint_id (string): Set the vpc_endpoint_id field on the resulting resource block. When null, the vpc_endpoint_id field will be omitted from the resulting object.
• 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 aws.datasync_agent.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• activation_key (string): Set the activation_key field on the resulting object. When null, the activation_key field will be omitted from the resulting object.
• ip_address (string): Set the ip_address field on the resulting object. When null, the ip_address field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
• private_link_endpoint (string): Set the private_link_endpoint field on the resulting object. When null, the private_link_endpoint field will be omitted from the resulting object.
• security_group_arns (list): Set the security_group_arns field on the resulting object. When null, the security_group_arns field will be omitted from the resulting object.
• subnet_arns (list): Set the subnet_arns field on the resulting object. When null, the subnet_arns field will be omitted from 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.
• vpc_endpoint_id (string): Set the vpc_endpoint_id field on the resulting object. When null, the vpc_endpoint_id field will be omitted from the resulting object.
• 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 aws.datasync_agent.timeouts.new constructor.

Returns:

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

fn withActivationKey

withActivationKey()

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

Args:

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

fn withIpAddress

withIpAddress()

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

Args:

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

fn withName

withName()

aws.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 withPrivateLinkEndpoint

withPrivateLinkEndpoint()

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

Args:

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

fn withSecurityGroupArns

withSecurityGroupArns()

aws.list.withSecurityGroupArns constructs a mixin object that can be merged into the list Terraform resource block to set or update the security_group_arns field.

Args:

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

fn withSubnetArns

withSubnetArns()

aws.list.withSubnetArns constructs a mixin object that can be merged into the list Terraform resource block to set or update the subnet_arns field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list): The value to set for the subnet_arns 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.

fn withTimeouts

withTimeouts()

aws.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 aws.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()

aws.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 aws.obj.withTimeouts function.

Args:

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

fn withVpcEndpointId

withVpcEndpointId()

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

Args:

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

obj timeouts

fn timeouts.new

new()

aws.datasync_agent.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.

Returns:

• An attribute object that represents the timeouts sub block.