Skip to content

Create Resource Configuration

vpclattice_create_resource_configuration R Documentation

Creates a resource configuration

Description

Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

Usage

vpclattice_create_resource_configuration(
  allowAssociationToShareableServiceNetwork, clientToken, name,
  portRanges, protocol, resourceConfigurationDefinition,
  resourceConfigurationGroupIdentifier, resourceGatewayIdentifier, tags,
  type)

Arguments

allowAssociationToShareableServiceNetwork

(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

name

[required] The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

portRanges

(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).

protocol

(SINGLE, GROUP) The protocol accepted by the resource configuration.

resourceConfigurationDefinition

(SINGLE, CHILD, ARN) The resource configuration.

resourceConfigurationGroupIdentifier

(CHILD) The ID or ARN of the parent resource configuration (type is GROUP). This is used to associate a child resource configuration with a group resource configuration.

resourceGatewayIdentifier

(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.

tags

The tags for the resource configuration.

type

[required] The type of resource configuration.

  • SINGLE - A single resource.

  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

Value

A list with the following syntax: 

list(
  allowAssociationToShareableServiceNetwork = TRUE|FALSE,
  arn = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  failureReason = "string",
  id = "string",
  name = "string",
  portRanges = list(
    "string"
  ),
  protocol = "TCP",
  resourceConfigurationDefinition = list(
    arnResource = list(
      arn = "string"
    ),
    dnsResource = list(
      domainName = "string",
      ipAddressType = "IPV4"|"IPV6"|"DUALSTACK"
    ),
    ipResource = list(
      ipAddress = "string"
    )
  ),
  resourceConfigurationGroupId = "string",
  resourceGatewayId = "string",
  status = "ACTIVE"|"CREATE_IN_PROGRESS"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
  type = "GROUP"|"CHILD"|"SINGLE"|"ARN"
)

Request syntax

svc$create_resource_configuration(
  allowAssociationToShareableServiceNetwork = TRUE|FALSE,
  clientToken = "string",
  name = "string",
  portRanges = list(
    "string"
  ),
  protocol = "TCP",
  resourceConfigurationDefinition = list(
    arnResource = list(
      arn = "string"
    ),
    dnsResource = list(
      domainName = "string",
      ipAddressType = "IPV4"|"IPV6"|"DUALSTACK"
    ),
    ipResource = list(
      ipAddress = "string"
    )
  ),
  resourceConfigurationGroupIdentifier = "string",
  resourceGatewayIdentifier = "string",
  tags = list(
    "string"
  ),
  type = "GROUP"|"CHILD"|"SINGLE"|"ARN"
)