Docs Home
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyral.IntegrationAwsIam
Explore with Pulumi AI
Authenticate users based on AWS IAM credentials.
Create IntegrationAwsIam Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IntegrationAwsIam(name: string, args: IntegrationAwsIamArgs, opts?: CustomResourceOptions);@overload
def IntegrationAwsIam(resource_name: str,
args: IntegrationAwsIamArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IntegrationAwsIam(resource_name: str,
opts: Optional[ResourceOptions] = None,
role_arns: Optional[Sequence[str]] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewIntegrationAwsIam(ctx *Context, name string, args IntegrationAwsIamArgs, opts ...ResourceOption) (*IntegrationAwsIam, error)public IntegrationAwsIam(string name, IntegrationAwsIamArgs args, CustomResourceOptions? opts = null)
public IntegrationAwsIam(String name, IntegrationAwsIamArgs args)
public IntegrationAwsIam(String name, IntegrationAwsIamArgs args, CustomResourceOptions options)
type: cyral:IntegrationAwsIam
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 IntegrationAwsIamArgs
- 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 IntegrationAwsIamArgs
- 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 IntegrationAwsIamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationAwsIamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationAwsIamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var integrationAwsIamResource = new Cyral.IntegrationAwsIam("integrationAwsIamResource", new()
{
RoleArns = new[]
{
"string",
},
Description = "string",
Name = "string",
});
example, err := cyral.NewIntegrationAwsIam(ctx, "integrationAwsIamResource", &cyral.IntegrationAwsIamArgs{
RoleArns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var integrationAwsIamResource = new IntegrationAwsIam("integrationAwsIamResource", IntegrationAwsIamArgs.builder()
.roleArns("string")
.description("string")
.name("string")
.build());
integration_aws_iam_resource = cyral.IntegrationAwsIam("integrationAwsIamResource",
role_arns=["string"],
description="string",
name="string")
const integrationAwsIamResource = new cyral.IntegrationAwsIam("integrationAwsIamResource", {
roleArns: ["string"],
description: "string",
name: "string",
});
type: cyral:IntegrationAwsIam
properties:
description: string
name: string
roleArns:
- string
IntegrationAwsIam 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 IntegrationAwsIam resource accepts the following input properties:
- Role
Arns List<string> - List of role ARNs which will be used for authentication.
- Description string
- Optional description of this integration.
- Name string
- The name of this AWS IAM Authentication integration.
- Role
Arns []string - List of role ARNs which will be used for authentication.
- Description string
- Optional description of this integration.
- Name string
- The name of this AWS IAM Authentication integration.
- role
Arns List<String> - List of role ARNs which will be used for authentication.
- description String
- Optional description of this integration.
- name String
- The name of this AWS IAM Authentication integration.
- role
Arns string[] - List of role ARNs which will be used for authentication.
- description string
- Optional description of this integration.
- name string
- The name of this AWS IAM Authentication integration.
- role_
arns Sequence[str] - List of role ARNs which will be used for authentication.
- description str
- Optional description of this integration.
- name str
- The name of this AWS IAM Authentication integration.
- role
Arns List<String> - List of role ARNs which will be used for authentication.
- description String
- Optional description of this integration.
- name String
- The name of this AWS IAM Authentication integration.
Outputs
All input properties are implicitly available as output properties. Additionally, the IntegrationAwsIam resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing IntegrationAwsIam Resource
Get an existing IntegrationAwsIam 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?: IntegrationAwsIamState, opts?: CustomResourceOptions): IntegrationAwsIam@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
role_arns: Optional[Sequence[str]] = None) -> IntegrationAwsIamfunc GetIntegrationAwsIam(ctx *Context, name string, id IDInput, state *IntegrationAwsIamState, opts ...ResourceOption) (*IntegrationAwsIam, error)public static IntegrationAwsIam Get(string name, Input<string> id, IntegrationAwsIamState? state, CustomResourceOptions? opts = null)public static IntegrationAwsIam get(String name, Output<String> id, IntegrationAwsIamState state, CustomResourceOptions options)resources: _: type: cyral:IntegrationAwsIam get: id: ${id}- 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.
- Description string
- Optional description of this integration.
- Name string
- The name of this AWS IAM Authentication integration.
- Role
Arns List<string> - List of role ARNs which will be used for authentication.
- Description string
- Optional description of this integration.
- Name string
- The name of this AWS IAM Authentication integration.
- Role
Arns []string - List of role ARNs which will be used for authentication.
- description String
- Optional description of this integration.
- name String
- The name of this AWS IAM Authentication integration.
- role
Arns List<String> - List of role ARNs which will be used for authentication.
- description string
- Optional description of this integration.
- name string
- The name of this AWS IAM Authentication integration.
- role
Arns string[] - List of role ARNs which will be used for authentication.
- description str
- Optional description of this integration.
- name str
- The name of this AWS IAM Authentication integration.
- role_
arns Sequence[str] - List of role ARNs which will be used for authentication.
- description String
- Optional description of this integration.
- name String
- The name of this AWS IAM Authentication integration.
- role
Arns List<String> - List of role ARNs which will be used for authentication.
Package Details
- Repository
- cyral cyralinc/terraform-provider-cyral
- License
- Notes
- This Pulumi package is based on the
cyralTerraform Provider.