Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

AccessConfiguration

Provides a Cloud SSO Access Configuration resource.

For information about Cloud SSO Access Configuration and how to use it, see What is Access Configuration.

NOTE: Available in v1.145.0+.

NOTE: Cloud SSO Only Support cn-shanghai And us-west-1 Region

Create a AccessConfiguration Resource

new AccessConfiguration(name: string, args: AccessConfigurationArgs, opts?: CustomResourceOptions);
@overload
def AccessConfiguration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        access_configuration_name: Optional[str] = None,
                        description: Optional[str] = None,
                        directory_id: Optional[str] = None,
                        force_remove_permission_policies: Optional[bool] = None,
                        permission_policies: Optional[Sequence[AccessConfigurationPermissionPolicyArgs]] = None,
                        relay_state: Optional[str] = None,
                        session_duration: Optional[int] = None)
@overload
def AccessConfiguration(resource_name: str,
                        args: AccessConfigurationArgs,
                        opts: Optional[ResourceOptions] = None)
func NewAccessConfiguration(ctx *Context, name string, args AccessConfigurationArgs, opts ...ResourceOption) (*AccessConfiguration, error)
public AccessConfiguration(string name, AccessConfigurationArgs args, CustomResourceOptions? opts = null)
public AccessConfiguration(String name, AccessConfigurationArgs args)
public AccessConfiguration(String name, AccessConfigurationArgs args, CustomResourceOptions options)
type: alicloud:cloudsso:AccessConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AccessConfigurationArgs
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 AccessConfigurationArgs
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 AccessConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccessConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AccessConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AccessConfiguration Resource Properties

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

Inputs

The AccessConfiguration resource accepts the following input properties:

AccessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

DirectoryId string

The ID of the Directory.

Description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

ForceRemovePermissionPolicies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

PermissionPolicies List<Pulumi.AliCloud.CloudSso.Inputs.AccessConfigurationPermissionPolicyArgs>

The Policy List. See the following Block permission_policies.

RelayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

SessionDuration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

AccessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

DirectoryId string

The ID of the Directory.

Description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

ForceRemovePermissionPolicies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

PermissionPolicies []AccessConfigurationPermissionPolicyArgs

The Policy List. See the following Block permission_policies.

RelayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

SessionDuration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationName String

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

directoryId String

The ID of the Directory.

description String

The Description of the Access Configuration. The description can be up to 1024 characters long.

forceRemovePermissionPolicies Boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies List<AccessConfigurationPermissionPolicyArgs>

The Policy List. See the following Block permission_policies.

relayState String

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration Integer

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

directoryId string

The ID of the Directory.

description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

forceRemovePermissionPolicies boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies AccessConfigurationPermissionPolicyArgs[]

The Policy List. See the following Block permission_policies.

relayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration number

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

access_configuration_name str

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

directory_id str

The ID of the Directory.

description str

The Description of the Access Configuration. The description can be up to 1024 characters long.

force_remove_permission_policies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permission_policies Sequence[AccessConfigurationPermissionPolicyArgs]

The Policy List. See the following Block permission_policies.

relay_state str

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

session_duration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationName String

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

directoryId String

The ID of the Directory.

description String

The Description of the Access Configuration. The description can be up to 1024 characters long.

forceRemovePermissionPolicies Boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies List<Property Map>

The Policy List. See the following Block permission_policies.

relayState String

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration Number

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

Outputs

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

AccessConfigurationId string

The AccessConfigurationId of the Access Configuration.

Id string

The provider-assigned unique ID for this managed resource.

AccessConfigurationId string

The AccessConfigurationId of the Access Configuration.

Id string

The provider-assigned unique ID for this managed resource.

accessConfigurationId String

The AccessConfigurationId of the Access Configuration.

id String

The provider-assigned unique ID for this managed resource.

accessConfigurationId string

The AccessConfigurationId of the Access Configuration.

id string

The provider-assigned unique ID for this managed resource.

access_configuration_id str

The AccessConfigurationId of the Access Configuration.

id str

The provider-assigned unique ID for this managed resource.

accessConfigurationId String

The AccessConfigurationId of the Access Configuration.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing AccessConfiguration Resource

Get an existing AccessConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AccessConfigurationState, opts?: CustomResourceOptions): AccessConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_configuration_id: Optional[str] = None,
        access_configuration_name: Optional[str] = None,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        force_remove_permission_policies: Optional[bool] = None,
        permission_policies: Optional[Sequence[AccessConfigurationPermissionPolicyArgs]] = None,
        relay_state: Optional[str] = None,
        session_duration: Optional[int] = None) -> AccessConfiguration
func GetAccessConfiguration(ctx *Context, name string, id IDInput, state *AccessConfigurationState, opts ...ResourceOption) (*AccessConfiguration, error)
public static AccessConfiguration Get(string name, Input<string> id, AccessConfigurationState? state, CustomResourceOptions? opts = null)
public static AccessConfiguration get(String name, Output<String> id, AccessConfigurationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessConfigurationId string

The AccessConfigurationId of the Access Configuration.

AccessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

Description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

ForceRemovePermissionPolicies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

PermissionPolicies List<Pulumi.AliCloud.CloudSso.Inputs.AccessConfigurationPermissionPolicyArgs>

The Policy List. See the following Block permission_policies.

RelayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

SessionDuration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

AccessConfigurationId string

The AccessConfigurationId of the Access Configuration.

AccessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

Description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

ForceRemovePermissionPolicies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

PermissionPolicies []AccessConfigurationPermissionPolicyArgs

The Policy List. See the following Block permission_policies.

RelayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

SessionDuration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationId String

The AccessConfigurationId of the Access Configuration.

accessConfigurationName String

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

description String

The Description of the Access Configuration. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

forceRemovePermissionPolicies Boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies List<AccessConfigurationPermissionPolicyArgs>

The Policy List. See the following Block permission_policies.

relayState String

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration Integer

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationId string

The AccessConfigurationId of the Access Configuration.

accessConfigurationName string

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

description string

The Description of the Access Configuration. The description can be up to 1024 characters long.

directoryId string

The ID of the Directory.

forceRemovePermissionPolicies boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies AccessConfigurationPermissionPolicyArgs[]

The Policy List. See the following Block permission_policies.

relayState string

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration number

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

access_configuration_id str

The AccessConfigurationId of the Access Configuration.

access_configuration_name str

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

description str

The Description of the Access Configuration. The description can be up to 1024 characters long.

directory_id str

The ID of the Directory.

force_remove_permission_policies bool

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permission_policies Sequence[AccessConfigurationPermissionPolicyArgs]

The Policy List. See the following Block permission_policies.

relay_state str

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

session_duration int

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

accessConfigurationId String

The AccessConfigurationId of the Access Configuration.

accessConfigurationName String

The AccessConfigurationName of the Access Configuration. The name of the resource. The name can be up to 32 characters long and can contain letters, digits, and hyphens (-).

description String

The Description of the Access Configuration. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

forceRemovePermissionPolicies Boolean

This parameter is used to force deletion permission_policies. Valid Value: true and false.

permissionPolicies List<Property Map>

The Policy List. See the following Block permission_policies.

relayState String

The RelayState of the Access Configuration, Cloud SSO users use this access configuration to access the RD account, the initial access page address. Must be the Alibaba Cloud console page, the default is the console home page.

sessionDuration Number

The SessionDuration of the Access Configuration. Valid Value: 900 to 43200. Unit: Seconds.

Supporting Types

AccessConfigurationPermissionPolicy

PermissionPolicyName string

The Policy Name of policy. The name of the resource.

PermissionPolicyType string

The Policy Type of policy. Valid values: System, Inline.

PermissionPolicyDocument string

The Content of Policy.

PermissionPolicyName string

The Policy Name of policy. The name of the resource.

PermissionPolicyType string

The Policy Type of policy. Valid values: System, Inline.

PermissionPolicyDocument string

The Content of Policy.

permissionPolicyName String

The Policy Name of policy. The name of the resource.

permissionPolicyType String

The Policy Type of policy. Valid values: System, Inline.

permissionPolicyDocument String

The Content of Policy.

permissionPolicyName string

The Policy Name of policy. The name of the resource.

permissionPolicyType string

The Policy Type of policy. Valid values: System, Inline.

permissionPolicyDocument string

The Content of Policy.

permission_policy_name str

The Policy Name of policy. The name of the resource.

permission_policy_type str

The Policy Type of policy. Valid values: System, Inline.

permission_policy_document str

The Content of Policy.

permissionPolicyName String

The Policy Name of policy. The name of the resource.

permissionPolicyType String

The Policy Type of policy. Valid values: System, Inline.

permissionPolicyDocument String

The Content of Policy.

Import

Cloud SSO Access Configuration can be imported using the id, e.g.

 $ pulumi import alicloud:cloudsso/accessConfiguration:AccessConfiguration example <directory_id>:<access_configuration_id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.