Skip to content

Latest commit

 

History

History
354 lines (206 loc) · 13 KB

apigee_addons_config.md

File metadata and controls

354 lines (206 loc) · 13 KB
Raw
permalink
/apigee_addons_config/

apigee_addons_config

apigee_addons_config represents the google_apigee_addons_config Terraform resource.

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

Index

Fields

fn new

new()

google.apigee_addons_config.new injects a new google_apigee_addons_config 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.apigee_addons_config.new('some_id')

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

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

This is the same as directly entering "${ google_apigee_addons_config.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.
  • org (string): Name of the Apigee organization.
  • addons_config (list[obj]): Addon configurations of the Apigee organization. When null, the addons_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.apigee_addons_config.addons_config.new constructor.
  • 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.apigee_addons_config.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike google.apigee_addons_config.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:

  • org (string): Name of the Apigee organization.
  • addons_config (list[obj]): Addon configurations of the Apigee organization. When null, the addons_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.apigee_addons_config.addons_config.new constructor.
  • 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.apigee_addons_config.timeouts.new constructor.

Returns:

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

fn withAddonsConfig

withAddonsConfig()

google.list[obj].withAddonsConfig constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the addons_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 google.list[obj].withAddonsConfigMixin function.

Args:

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

fn withAddonsConfigMixin

withAddonsConfigMixin()

google.list[obj].withAddonsConfigMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the addons_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 google.list[obj].withAddonsConfig function.

Args:

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

fn withOrg

withOrg()

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

Args:

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

fn addons_config.new

new()

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

Args:

Returns:

  • An attribute object that represents the addons_config sub block.

obj addons_config.advanced_api_ops_config

fn addons_config.advanced_api_ops_config.new

new()

google.apigee_addons_config.addons_config.advanced_api_ops_config.new constructs a new object with attributes and blocks configured for the advanced_api_ops_config Terraform sub block.

Args:

  • enabled (bool): Flag that specifies whether the Advanced API Ops add-on is enabled. When null, the enabled field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the advanced_api_ops_config sub block.

obj addons_config.api_security_config

fn addons_config.api_security_config.new

new()

google.apigee_addons_config.addons_config.api_security_config.new constructs a new object with attributes and blocks configured for the api_security_config Terraform sub block.

Args:

  • enabled (bool): Flag that specifies whether the Advanced API Ops add-on is enabled. When null, the enabled field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the api_security_config sub block.

obj addons_config.connectors_platform_config

fn addons_config.connectors_platform_config.new

new()

google.apigee_addons_config.addons_config.connectors_platform_config.new constructs a new object with attributes and blocks configured for the connectors_platform_config Terraform sub block.

Args:

  • enabled (bool): Flag that specifies whether the Advanced API Ops add-on is enabled. When null, the enabled field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the connectors_platform_config sub block.

obj addons_config.integration_config

fn addons_config.integration_config.new

new()

google.apigee_addons_config.addons_config.integration_config.new constructs a new object with attributes and blocks configured for the integration_config Terraform sub block.

Args:

  • enabled (bool): Flag that specifies whether the Advanced API Ops add-on is enabled. When null, the enabled field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the integration_config sub block.

obj addons_config.monetization_config

fn addons_config.monetization_config.new

new()

google.apigee_addons_config.addons_config.monetization_config.new constructs a new object with attributes and blocks configured for the monetization_config Terraform sub block.

Args:

  • enabled (bool): Flag that specifies whether the Advanced API Ops add-on is enabled. When null, the enabled field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the monetization_config sub block.

obj timeouts

fn timeouts.new

new()

google.apigee_addons_config.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.
  • update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.