Create Environment
datazone_create_environment | R Documentation |
Create an Amazon DataZone environment¶
Description¶
Create an Amazon DataZone environment.
Usage¶
datazone_create_environment(deploymentOrder, description,
domainIdentifier, environmentAccountIdentifier,
environmentAccountRegion, environmentBlueprintIdentifier,
environmentConfigurationId, environmentProfileIdentifier, glossaryTerms,
name, projectIdentifier, userParameters)
Arguments¶
deploymentOrder |
The deployment order of the environment. |
description |
The description of the Amazon DataZone environment. |
domainIdentifier |
[required] The identifier of the Amazon DataZone domain in which the environment is created. |
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. |
environmentConfigurationId |
The configuration ID of the environment. |
environmentProfileIdentifier |
[required] The identifier of the environment profile that is used to create this Amazon DataZone environment. |
glossaryTerms |
The glossary terms that can be used in this Amazon DataZone environment. |
name |
[required] The name of the Amazon DataZone environment. |
projectIdentifier |
[required] The identifier of the Amazon DataZone project in which this environment is created. |
userParameters |
The user parameters of this Amazon DataZone environment. |
Value¶
A list with the following syntax:
list(
awsAccountId = "string",
awsAccountRegion = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
deploymentProperties = list(
endTimeoutMinutes = 123,
startTimeoutMinutes = 123
),
description = "string",
domainId = "string",
environmentActions = list(
list(
auth = "IAM"|"HTTPS",
parameters = list(
list(
key = "string",
value = "string"
)
),
type = "string"
)
),
environmentBlueprintId = "string",
environmentProfileId = "string",
glossaryTerms = list(
"string"
),
id = "string",
lastDeployment = list(
deploymentId = "string",
deploymentStatus = "IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"PENDING_DEPLOYMENT",
deploymentType = "CREATE"|"UPDATE"|"DELETE",
failureReason = list(
code = "string",
message = "string"
),
isDeploymentComplete = TRUE|FALSE,
messages = list(
"string"
)
),
name = "string",
projectId = "string",
provider = "string",
provisionedResources = list(
list(
name = "string",
provider = "string",
type = "string",
value = "string"
)
),
provisioningProperties = list(
cloudFormation = list(
templateUrl = "string"
)
),
status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"VALIDATION_FAILED"|"SUSPENDED"|"DISABLED"|"EXPIRED"|"DELETED"|"INACCESSIBLE",
updatedAt = as.POSIXct(
"2015-01-01"
),
userParameters = list(
list(
defaultValue = "string",
description = "string",
fieldType = "string",
isEditable = TRUE|FALSE,
isOptional = TRUE|FALSE,
keyName = "string"
)
)
)
Request syntax¶
svc$create_environment(
deploymentOrder = 123,
description = "string",
domainIdentifier = "string",
environmentAccountIdentifier = "string",
environmentAccountRegion = "string",
environmentBlueprintIdentifier = "string",
environmentConfigurationId = "string",
environmentProfileIdentifier = "string",
glossaryTerms = list(
"string"
),
name = "string",
projectIdentifier = "string",
userParameters = list(
list(
name = "string",
value = "string"
)
)
)