Skip to content

Create an Amazon DataZone environment

Description

Create an Amazon DataZone environment.

Usage

datazone_create_environment(projectIdentifier, domainIdentifier,
  description, name, environmentProfileIdentifier, userParameters,
  glossaryTerms, environmentAccountIdentifier, environmentAccountRegion,
  environmentBlueprintIdentifier, deploymentOrder,
  environmentConfigurationId, environmentConfigurationName)

Arguments

  • projectIdentifier

    [required] The identifier of the Amazon DataZone project in which this environment is created.

  • domainIdentifier

    [required] The identifier of the Amazon DataZone domain in which the environment is created.

  • description

    The description of the Amazon DataZone environment.

  • name

    [required] The name of the Amazon DataZone environment.

  • environmentProfileIdentifier

    The identifier of the environment profile that is used to create this Amazon DataZone environment.

  • userParameters

    The user parameters of this Amazon DataZone environment.

  • glossaryTerms

    The glossary terms that can be used in this Amazon DataZone environment.

  • environmentAccountIdentifier

    The ID of the account in which the environment is being created.

  • environmentAccountRegion

    The region of the account in which the environment is being created.

  • environmentBlueprintIdentifier

    The ID of the blueprint with which the environment is being created.

    This parameter is only valid for V1 domains. If provided for a V2 domain, the service returns a ValidationException.

  • deploymentOrder

    The deployment order of the environment.

  • environmentConfigurationId

    The configuration ID of the environment.

  • environmentConfigurationName

    The configuration name of the environment.

Value

A list with the following syntax:

list(
  projectId = "string",
  id = "string",
  domainId = "string",
  createdBy = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  name = "string",
  description = "string",
  environmentProfileId = "string",
  awsAccountId = "string",
  awsAccountRegion = "string",
  provider = "string",
  provisionedResources = list(
    list(
      provider = "string",
      name = "string",
      value = "string",
      type = "string"
    )
  ),
  status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"VALIDATION_FAILED"|"SUSPENDED"|"DISABLED"|"EXPIRED"|"DELETED"|"INACCESSIBLE",
  environmentActions = list(
    list(
      type = "string",
      auth = "IAM"|"HTTPS",
      parameters = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  glossaryTerms = list(
    "string"
  ),
  userParameters = list(
    list(
      keyName = "string",
      description = "string",
      fieldType = "string",
      defaultValue = "string",
      isEditable = TRUE|FALSE,
      isOptional = TRUE|FALSE,
      isUpdateSupported = TRUE|FALSE
    )
  ),
  lastDeployment = list(
    deploymentId = "string",
    deploymentType = "CREATE"|"UPDATE"|"DELETE",
    deploymentStatus = "IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"PENDING_DEPLOYMENT",
    failureReason = list(
      code = "string",
      message = "string"
    ),
    messages = list(
      "string"
    ),
    isDeploymentComplete = TRUE|FALSE
  ),
  provisioningProperties = list(
    cloudFormation = list(
      templateUrl = "string"
    )
  ),
  deploymentProperties = list(
    startTimeoutMinutes = 123,
    endTimeoutMinutes = 123
  ),
  environmentBlueprintId = "string",
  environmentConfigurationId = "string",
  environmentConfigurationName = "string"
)

Request syntax

svc$create_environment(
  projectIdentifier = "string",
  domainIdentifier = "string",
  description = "string",
  name = "string",
  environmentProfileIdentifier = "string",
  userParameters = list(
    list(
      name = "string",
      value = "string"
    )
  ),
  glossaryTerms = list(
    "string"
  ),
  environmentAccountIdentifier = "string",
  environmentAccountRegion = "string",
  environmentBlueprintIdentifier = "string",
  deploymentOrder = 123,
  environmentConfigurationId = "string",
  environmentConfigurationName = "string"
)