IdpAuthConfigurationProperty Struct
External identity provider configuration for the Operator App.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';
const idpAuthConfigurationProperty: devopsagent.CfnAgentSpace.IdpAuthConfigurationProperty = {
clientId: 'clientId',
clientSecret: 'clientSecret',
issuerUrl: 'issuerUrl',
operatorAppRoleArn: 'operatorAppRoleArn',
provider: 'provider',
// the properties below are optional
createdAt: 'createdAt',
updatedAt: 'updatedAt',
userIdClaim: 'userIdClaim',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent
idp_auth_configuration_property = devopsagent.CfnAgentSpace.IdpAuthConfigurationProperty(
client_id="clientId",
client_secret="clientSecret",
issuer_url="issuerUrl",
operator_app_role_arn="operatorAppRoleArn",
provider="provider",
# the properties below are optional
created_at="createdAt",
updated_at="updatedAt",
user_id_claim="userIdClaim"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.devopsagent.*;
IdpAuthConfigurationProperty idpAuthConfigurationProperty = IdpAuthConfigurationProperty.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.issuerUrl("issuerUrl")
.operatorAppRoleArn("operatorAppRoleArn")
.provider("provider")
// the properties below are optional
.createdAt("createdAt")
.updatedAt("updatedAt")
.userIdClaim("userIdClaim")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DevOpsAgent;
var idpAuthConfigurationProperty = new IdpAuthConfigurationProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
IssuerUrl = "issuerUrl",
OperatorAppRoleArn = "operatorAppRoleArn",
Provider = "provider",
// the properties below are optional
CreatedAt = "createdAt",
UpdatedAt = "updatedAt",
UserIdClaim = "userIdClaim"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
idpAuthConfigurationProperty := &IdpAuthConfigurationProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
IssuerUrl: jsii.String("issuerUrl"),
OperatorAppRoleArn: jsii.String("operatorAppRoleArn"),
Provider: jsii.String("provider"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
UpdatedAt: jsii.String("updatedAt"),
UserIdClaim: jsii.String("userIdClaim"),
}
Properties
The OIDC client identifier for the external identity provider application.
clientSecretstringclient_secretstrclientSecretStringClientSecretstringClientSecret*string required #The OIDC client secret for the external identity provider application.
Use a Secrets Manager dynamic reference to avoid storing the secret in the template.
createdAtoptionalstringcreated_atoptionalstrcreatedAtoptionalStringCreatedAtoptionalstringCreatedAtoptional*string #The OIDC issuer URL for the external identity provider.
operatorAppRoleArnstringoperator_app_role_arnstroperatorAppRoleArnStringOperatorAppRoleArnstringOperatorAppRoleArn*string required #The IAM role that Operator App users assume to access DevOps Agent APIs.
The external identity provider type.
updatedAtoptionalstringupdated_atoptionalstrupdatedAtoptionalStringUpdatedAtoptionalstringUpdatedAtoptional*string #userIdClaimoptionalstringuser_id_claimoptionalstruserIdClaimoptionalStringUserIdClaimoptionalstringUserIdClaimoptional*string #The identity claim used to identify users.
This value is selected by the service for the configured provider.