1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesweb
  5. getNetworkSettings

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.workspacesweb.getNetworkSettings

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Definition of AWS::WorkSpacesWeb::NetworkSettings Resource Type

    Using getNetworkSettings

    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 getNetworkSettings(args: GetNetworkSettingsArgs, opts?: InvokeOptions): Promise<GetNetworkSettingsResult>
    function getNetworkSettingsOutput(args: GetNetworkSettingsOutputArgs, opts?: InvokeOptions): Output<GetNetworkSettingsResult>
    def get_network_settings(network_settings_arn: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetNetworkSettingsResult
    def get_network_settings_output(network_settings_arn: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetNetworkSettingsResult]
    func LookupNetworkSettings(ctx *Context, args *LookupNetworkSettingsArgs, opts ...InvokeOption) (*LookupNetworkSettingsResult, error)
    func LookupNetworkSettingsOutput(ctx *Context, args *LookupNetworkSettingsOutputArgs, opts ...InvokeOption) LookupNetworkSettingsResultOutput

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

    public static class GetNetworkSettings 
    {
        public static Task<GetNetworkSettingsResult> InvokeAsync(GetNetworkSettingsArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkSettingsResult> Invoke(GetNetworkSettingsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkSettingsResult> getNetworkSettings(GetNetworkSettingsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:workspacesweb:getNetworkSettings
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NetworkSettingsArn string
    The ARN of the network settings.
    NetworkSettingsArn string
    The ARN of the network settings.
    networkSettingsArn String
    The ARN of the network settings.
    networkSettingsArn string
    The ARN of the network settings.
    network_settings_arn str
    The ARN of the network settings.
    networkSettingsArn String
    The ARN of the network settings.

    getNetworkSettings Result

    The following output properties are available:

    AssociatedPortalArns List<string>
    A list of web portal ARNs that this network settings is associated with.
    NetworkSettingsArn string
    The ARN of the network settings.
    SecurityGroupIds List<string>

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    SubnetIds List<string>

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to add to the network settings resource. A tag is a key-value pair.
    VpcId string

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    AssociatedPortalArns []string
    A list of web portal ARNs that this network settings is associated with.
    NetworkSettingsArn string
    The ARN of the network settings.
    SecurityGroupIds []string

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    SubnetIds []string

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    Tags Tag
    The tags to add to the network settings resource. A tag is a key-value pair.
    VpcId string

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    associatedPortalArns List<String>
    A list of web portal ARNs that this network settings is associated with.
    networkSettingsArn String
    The ARN of the network settings.
    securityGroupIds List<String>

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    subnetIds List<String>

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    tags List<Tag>
    The tags to add to the network settings resource. A tag is a key-value pair.
    vpcId String

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    associatedPortalArns string[]
    A list of web portal ARNs that this network settings is associated with.
    networkSettingsArn string
    The ARN of the network settings.
    securityGroupIds string[]

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    subnetIds string[]

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    tags Tag[]
    The tags to add to the network settings resource. A tag is a key-value pair.
    vpcId string

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    associated_portal_arns Sequence[str]
    A list of web portal ARNs that this network settings is associated with.
    network_settings_arn str
    The ARN of the network settings.
    security_group_ids Sequence[str]

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    subnet_ids Sequence[str]

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    tags Sequence[root_Tag]
    The tags to add to the network settings resource. A tag is a key-value pair.
    vpc_id str

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    associatedPortalArns List<String>
    A list of web portal ARNs that this network settings is associated with.
    networkSettingsArn String
    The ARN of the network settings.
    securityGroupIds List<String>

    One or more security groups used to control access from streaming instances to your VPC.

    Pattern : ^[\w+\-]+$

    subnetIds List<String>

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    Pattern : ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

    tags List<Property Map>
    The tags to add to the network settings resource. A tag is a key-value pair.
    vpcId String

    The VPC that streaming instances will connect to.

    Pattern : ^vpc-[0-9a-z]*$

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi