Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. comprehend
  5. getFlywheel

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.comprehend.getFlywheel

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.

Using getFlywheel

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 getFlywheel(args: GetFlywheelArgs, opts?: InvokeOptions): Promise<GetFlywheelResult>
function getFlywheelOutput(args: GetFlywheelOutputArgs, opts?: InvokeOptions): Output<GetFlywheelResult>
Copy
def get_flywheel(arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFlywheelResult
def get_flywheel_output(arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFlywheelResult]
Copy
func LookupFlywheel(ctx *Context, args *LookupFlywheelArgs, opts ...InvokeOption) (*LookupFlywheelResult, error)
func LookupFlywheelOutput(ctx *Context, args *LookupFlywheelOutputArgs, opts ...InvokeOption) LookupFlywheelResultOutput
Copy

> Note: This function is named LookupFlywheel in the Go SDK.

public static class GetFlywheel 
{
    public static Task<GetFlywheelResult> InvokeAsync(GetFlywheelArgs args, InvokeOptions? opts = null)
    public static Output<GetFlywheelResult> Invoke(GetFlywheelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFlywheelResult> getFlywheel(GetFlywheelArgs args, InvokeOptions options)
public static Output<GetFlywheelResult> getFlywheel(GetFlywheelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:comprehend:getFlywheel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
The Amazon Resource Name (ARN) of the flywheel.
Arn This property is required. string
The Amazon Resource Name (ARN) of the flywheel.
arn This property is required. String
The Amazon Resource Name (ARN) of the flywheel.
arn This property is required. string
The Amazon Resource Name (ARN) of the flywheel.
arn This property is required. str
The Amazon Resource Name (ARN) of the flywheel.
arn This property is required. String
The Amazon Resource Name (ARN) of the flywheel.

getFlywheel Result

The following output properties are available:

ActiveModelArn string
The Amazon Resource Number (ARN) of the active model version.
Arn string
The Amazon Resource Name (ARN) of the flywheel.
DataAccessRoleArn string
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
DataSecurityConfig Pulumi.AwsNative.Comprehend.Outputs.FlywheelDataSecurityConfig
Data security configuration.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
ActiveModelArn string
The Amazon Resource Number (ARN) of the active model version.
Arn string
The Amazon Resource Name (ARN) of the flywheel.
DataAccessRoleArn string
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
DataSecurityConfig FlywheelDataSecurityConfig
Data security configuration.
Tags Tag
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
activeModelArn String
The Amazon Resource Number (ARN) of the active model version.
arn String
The Amazon Resource Name (ARN) of the flywheel.
dataAccessRoleArn String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
dataSecurityConfig FlywheelDataSecurityConfig
Data security configuration.
tags List<Tag>
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
activeModelArn string
The Amazon Resource Number (ARN) of the active model version.
arn string
The Amazon Resource Name (ARN) of the flywheel.
dataAccessRoleArn string
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
dataSecurityConfig FlywheelDataSecurityConfig
Data security configuration.
tags Tag[]
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
active_model_arn str
The Amazon Resource Number (ARN) of the active model version.
arn str
The Amazon Resource Name (ARN) of the flywheel.
data_access_role_arn str
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
data_security_config FlywheelDataSecurityConfig
Data security configuration.
tags Sequence[root_Tag]
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
activeModelArn String
The Amazon Resource Number (ARN) of the active model version.
arn String
The Amazon Resource Name (ARN) of the flywheel.
dataAccessRoleArn String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
dataSecurityConfig Property Map
Data security configuration.
tags List<Property Map>
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

Supporting Types

FlywheelDataSecurityConfig

DataLakeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
ModelKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VolumeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
VpcConfig Pulumi.AwsNative.Comprehend.Inputs.FlywheelVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .
DataLakeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
ModelKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VolumeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
VpcConfig FlywheelVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .
dataLakeKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
modelKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volumeKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
vpcConfig FlywheelVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .
dataLakeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
modelKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volumeKmsKeyId string
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
vpcConfig FlywheelVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .
data_lake_kms_key_id str
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
model_kms_key_id str
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volume_kms_key_id str
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
vpc_config FlywheelVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .
dataLakeKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
modelKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volumeKmsKeyId String
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
vpcConfig Property Map
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC .

FlywheelVpcConfig

SecurityGroupIds This property is required. List<string>
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
Subnets This property is required. List<string>
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .
SecurityGroupIds This property is required. []string
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
Subnets This property is required. []string
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .
securityGroupIds This property is required. List<String>
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
subnets This property is required. List<String>
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .
securityGroupIds This property is required. string[]
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
subnets This property is required. string[]
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .
security_group_ids This property is required. Sequence[str]
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
subnets This property is required. Sequence[str]
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .
securityGroupIds This property is required. List<String>
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC .
subnets This property is required. List<String>
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets .

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the 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.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native