We recommend new projects start with resources from the AWS provider.
aws-native.evs.getEnvironment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An environment created within the EVS service
Using getEnvironment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
def get_environment(environment_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
> Note: This function is named LookupEnvironment
in the Go SDK.
public static class GetEnvironment
{
public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:evs:getEnvironment
arguments:
# arguments dictionary
The following arguments are supported:
- Environment
Id string - The unique ID for the environment. For example:
env-1234567890
.
- Environment
Id string - The unique ID for the environment. For example:
env-1234567890
.
- environment
Id String - The unique ID for the environment. For example:
env-1234567890
.
- environment
Id string - The unique ID for the environment. For example:
env-1234567890
.
- environment_
id str - The unique ID for the environment. For example:
env-1234567890
.
- environment
Id String - The unique ID for the environment. For example:
env-1234567890
.
getEnvironment Result
The following output properties are available:
- Checks
List<Pulumi.
Aws Native. Evs. Outputs. Environment Check> A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- Created
At string - The date and time that the environment was created. For example:
1749081600.000
. - Credentials
List<Pulumi.
Aws Native. Evs. Outputs. Environment Secret> The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- Environment
Arn string - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - Environment
Id string - The unique ID for the environment. For example:
env-1234567890
. - Environment
State Pulumi.Aws Native. Evs. Environment State - The state of an environment. For example:
CREATED
. - Modified
At string - The date and time that the environment was modified. For example:
1749081600.000
. - State
Details string - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Checks
[]Environment
Check A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- Created
At string - The date and time that the environment was created. For example:
1749081600.000
. - Credentials
[]Environment
Secret The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- Environment
Arn string - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - Environment
Id string - The unique ID for the environment. For example:
env-1234567890
. - Environment
State EnvironmentState Enum - The state of an environment. For example:
CREATED
. - Modified
At string - The date and time that the environment was modified. For example:
1749081600.000
. - State
Details string - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - Tag
- An array of key-value pairs to apply to this resource.
- checks
List<Environment
Check> A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- created
At String - The date and time that the environment was created. For example:
1749081600.000
. - credentials
List<Environment
Secret> The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- environment
Arn String - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - environment
Id String - The unique ID for the environment. For example:
env-1234567890
. - environment
State EnvironmentState - The state of an environment. For example:
CREATED
. - modified
At String - The date and time that the environment was modified. For example:
1749081600.000
. - state
Details String - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - List<Tag>
- An array of key-value pairs to apply to this resource.
- checks
Environment
Check[] A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- created
At string - The date and time that the environment was created. For example:
1749081600.000
. - credentials
Environment
Secret[] The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- environment
Arn string - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - environment
Id string - The unique ID for the environment. For example:
env-1234567890
. - environment
State EnvironmentState - The state of an environment. For example:
CREATED
. - modified
At string - The date and time that the environment was modified. For example:
1749081600.000
. - state
Details string - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - Tag[]
- An array of key-value pairs to apply to this resource.
- checks
Sequence[Environment
Check] A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- created_
at str - The date and time that the environment was created. For example:
1749081600.000
. - credentials
Sequence[Environment
Secret] The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- environment_
arn str - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - environment_
id str - The unique ID for the environment. For example:
env-1234567890
. - environment_
state EnvironmentState - The state of an environment. For example:
CREATED
. - modified_
at str - The date and time that the environment was modified. For example:
1749081600.000
. - state_
details str - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- checks List<Property Map>
A check on the environment to identify instance health and VMware VCF licensing issues. For example:
{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }
- created
At String - The date and time that the environment was created. For example:
1749081600.000
. - credentials List<Property Map>
The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:
{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }
- environment
Arn String - The Amazon Resource Name (ARN) that is associated with the environment. For example:
arn:aws:evs:us-east-1:000000000000:environment/env-1234567890
. - environment
Id String - The unique ID for the environment. For example:
env-1234567890
. - environment
State "CREATING" | "CREATED" | "DELETING" | "DELETED" | "CREATE_FAILED" - The state of an environment. For example:
CREATED
. - modified
At String - The date and time that the environment was modified. For example:
1749081600.000
. - state
Details String - A detailed description of the
environmentState
of an environment. For example:Environment successfully created
. - List<Property Map>
- An array of key-value pairs to apply to this resource.
Supporting Types
EnvironmentCheck
- Result
Pulumi.
Aws Native. Evs. Environment Check Result - The check result.
- Type
Pulumi.
Aws Native. Evs. Environment Check Type The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- Impaired
Since string - The time when environment health began to be impaired.
- Result
Environment
Check Result - The check result.
- Type
Environment
Check Type The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- Impaired
Since string - The time when environment health began to be impaired.
- result
Environment
Check Result - The check result.
- type
Environment
Check Type The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- impaired
Since String - The time when environment health began to be impaired.
- result
Environment
Check Result - The check result.
- type
Environment
Check Type The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- impaired
Since string - The time when environment health began to be impaired.
- result
Environment
Check Result - The check result.
- type
Environment
Check Type The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- impaired_
since str - The time when environment health began to be impaired.
- result "PASSED" | "FAILED" | "UNKNOWN"
- The check result.
- type "KEY_REUSE" | "KEY_COVERAGE" | "REACHABILITY" | "VCF_VERSION" | "HOST_COUNT"
The check type. Amazon EVS performs the following checks.
KEY_REUSE
: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.KEY_COVERAGE
: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.REACHABILITY
: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.HOST_COUNT
: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.
If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.
- impaired
Since String - The time when environment health began to be impaired.
EnvironmentCheckResult
EnvironmentCheckType
EnvironmentSecret
- Secret
Arn string - The Amazon Resource Name (ARN) of the secret.
- Secret
Arn string - The Amazon Resource Name (ARN) of the secret.
- secret
Arn String - The Amazon Resource Name (ARN) of the secret.
- secret
Arn string - The Amazon Resource Name (ARN) of the secret.
- secret_
arn str - The Amazon Resource Name (ARN) of the secret.
- secret
Arn String - The Amazon Resource Name (ARN) of the secret.
EnvironmentState
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.