Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesweb
  5. IpAccessSettings

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesweb.IpAccessSettings

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type

    Create IpAccessSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IpAccessSettings(name: string, args: IpAccessSettingsArgs, opts?: CustomResourceOptions);
    @overload
def IpAccessSettings(resource_name: str,
                     args: IpAccessSettingsArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def IpAccessSettings(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     ip_rules: Optional[Sequence[IpAccessSettingsIpRuleArgs]] = None,
                     additional_encryption_context: Optional[Mapping[str, str]] = None,
                     customer_managed_key: Optional[str] = None,
                     description: Optional[str] = None,
                     display_name: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewIpAccessSettings(ctx *Context, name string, args IpAccessSettingsArgs, opts ...ResourceOption) (*IpAccessSettings, error)
    public IpAccessSettings(string name, IpAccessSettingsArgs args, CustomResourceOptions? opts = null)
    public IpAccessSettings(String name, IpAccessSettingsArgs args)
public IpAccessSettings(String name, IpAccessSettingsArgs args, CustomResourceOptions options)

    type: aws-native:workspacesweb:IpAccessSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpAccessSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IpAccessSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IpAccessSettings resource accepts the following input properties:

    IpRules List<Pulumi.AwsNative.WorkSpacesWeb.Inputs.IpAccessSettingsIpRule>
    The IP rules of the IP access settings.
    AdditionalEncryptionContext Dictionary<string, string>
    Additional encryption context of the IP access settings.
    CustomerManagedKey string

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    Description string
    The description of the IP access settings.
    DisplayName string
    The display name of the IP access settings.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to add to the IP access settings resource. A tag is a key-value pair.
    IpRules []IpAccessSettingsIpRuleArgs
    The IP rules of the IP access settings.
    AdditionalEncryptionContext map[string]string
    Additional encryption context of the IP access settings.
    CustomerManagedKey string

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    Description string
    The description of the IP access settings.
    DisplayName string
    The display name of the IP access settings.
    Tags TagArgs
    The tags to add to the IP access settings resource. A tag is a key-value pair.
    ipRules List<IpAccessSettingsIpRule>
    The IP rules of the IP access settings.
    additionalEncryptionContext Map<String,String>
    Additional encryption context of the IP access settings.
    customerManagedKey String

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    description String
    The description of the IP access settings.
    displayName String
    The display name of the IP access settings.
    tags List<Tag>
    The tags to add to the IP access settings resource. A tag is a key-value pair.
    ipRules IpAccessSettingsIpRule[]
    The IP rules of the IP access settings.
    additionalEncryptionContext {[key: string]: string}
    Additional encryption context of the IP access settings.
    customerManagedKey string

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    description string
    The description of the IP access settings.
    displayName string
    The display name of the IP access settings.
    tags Tag[]
    The tags to add to the IP access settings resource. A tag is a key-value pair.
    ip_rules Sequence[IpAccessSettingsIpRuleArgs]
    The IP rules of the IP access settings.
    additional_encryption_context Mapping[str, str]
    Additional encryption context of the IP access settings.
    customer_managed_key str

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    description str
    The description of the IP access settings.
    display_name str
    The display name of the IP access settings.
    tags Sequence[TagArgs]
    The tags to add to the IP access settings resource. A tag is a key-value pair.
    ipRules List<Property Map>
    The IP rules of the IP access settings.
    additionalEncryptionContext Map<String>
    Additional encryption context of the IP access settings.
    customerManagedKey String

    The custom managed key of the IP access settings.

    Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

    description String
    The description of the IP access settings.
    displayName String
    The display name of the IP access settings.
    tags List<Property Map>
    The tags to add to the IP access settings resource. A tag is a key-value pair.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpAccessSettings resource produces the following output properties:

    AssociatedPortalArns List<string>
    A list of web portal ARNs that this IP access settings resource is associated with.
    CreationDate string
    The creation date timestamp of the IP access settings.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    The ARN of the IP access settings resource.
    AssociatedPortalArns []string
    A list of web portal ARNs that this IP access settings resource is associated with.
    CreationDate string
    The creation date timestamp of the IP access settings.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    The ARN of the IP access settings resource.
    associatedPortalArns List<String>
    A list of web portal ARNs that this IP access settings resource is associated with.
    creationDate String
    The creation date timestamp of the IP access settings.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    The ARN of the IP access settings resource.
    associatedPortalArns string[]
    A list of web portal ARNs that this IP access settings resource is associated with.
    creationDate string
    The creation date timestamp of the IP access settings.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn string
    The ARN of the IP access settings resource.
    associated_portal_arns Sequence[str]
    A list of web portal ARNs that this IP access settings resource is associated with.
    creation_date str
    The creation date timestamp of the IP access settings.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_access_settings_arn str
    The ARN of the IP access settings resource.
    associatedPortalArns List<String>
    A list of web portal ARNs that this IP access settings resource is associated with.
    creationDate String
    The creation date timestamp of the IP access settings.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    The ARN of the IP access settings resource.

    Supporting Types

    IpAccessSettingsIpRule, IpAccessSettingsIpRuleArgs

    IpRange string
    A single IP address or an IP address range in CIDR notation
    Description string
    The description of the IP rule.
    IpRange string
    A single IP address or an IP address range in CIDR notation
    Description string
    The description of the IP rule.
    ipRange String
    A single IP address or an IP address range in CIDR notation
    description String
    The description of the IP rule.
    ipRange string
    A single IP address or an IP address range in CIDR notation
    description string
    The description of the IP rule.
    ip_range str
    A single IP address or an IP address range in CIDR notation
    description str
    The description of the IP rule.
    ipRange String
    A single IP address or an IP address range in CIDR notation
    description String
    The description of the IP rule.

    Tag, TagArgs

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native