Documentation ¶
Index ¶
- func CfnBrowserSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBrowserSettings_IsCfnElement(x interface{}) *bool
- func CfnBrowserSettings_IsCfnResource(x interface{}) *bool
- func CfnBrowserSettings_IsConstruct(x interface{}) *bool
- func CfnIdentityProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdentityProvider_IsCfnElement(x interface{}) *bool
- func CfnIdentityProvider_IsCfnResource(x interface{}) *bool
- func CfnIdentityProvider_IsConstruct(x interface{}) *bool
- func CfnIpAccessSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIpAccessSettings_IsCfnElement(x interface{}) *bool
- func CfnIpAccessSettings_IsCfnResource(x interface{}) *bool
- func CfnIpAccessSettings_IsConstruct(x interface{}) *bool
- func CfnNetworkSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkSettings_IsCfnElement(x interface{}) *bool
- func CfnNetworkSettings_IsCfnResource(x interface{}) *bool
- func CfnNetworkSettings_IsConstruct(x interface{}) *bool
- func CfnPortal_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPortal_IsCfnElement(x interface{}) *bool
- func CfnPortal_IsCfnResource(x interface{}) *bool
- func CfnPortal_IsConstruct(x interface{}) *bool
- func CfnTrustStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrustStore_IsCfnElement(x interface{}) *bool
- func CfnTrustStore_IsCfnResource(x interface{}) *bool
- func CfnTrustStore_IsConstruct(x interface{}) *bool
- func CfnUserAccessLoggingSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserAccessLoggingSettings_IsCfnElement(x interface{}) *bool
- func CfnUserAccessLoggingSettings_IsCfnResource(x interface{}) *bool
- func CfnUserAccessLoggingSettings_IsConstruct(x interface{}) *bool
- func CfnUserSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserSettings_IsCfnElement(x interface{}) *bool
- func CfnUserSettings_IsCfnResource(x interface{}) *bool
- func CfnUserSettings_IsConstruct(x interface{}) *bool
- func NewCfnBrowserSettings_Override(c CfnBrowserSettings, scope constructs.Construct, id *string, ...)
- func NewCfnIdentityProvider_Override(c CfnIdentityProvider, scope constructs.Construct, id *string, ...)
- func NewCfnIpAccessSettings_Override(c CfnIpAccessSettings, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkSettings_Override(c CfnNetworkSettings, scope constructs.Construct, id *string, ...)
- func NewCfnPortal_Override(c CfnPortal, scope constructs.Construct, id *string, props *CfnPortalProps)
- func NewCfnTrustStore_Override(c CfnTrustStore, scope constructs.Construct, id *string, ...)
- func NewCfnUserAccessLoggingSettings_Override(c CfnUserAccessLoggingSettings, scope constructs.Construct, id *string, ...)
- func NewCfnUserSettings_Override(c CfnUserSettings, scope constructs.Construct, id *string, ...)
- type CfnBrowserSettings
- type CfnBrowserSettingsProps
- type CfnIdentityProvider
- type CfnIdentityProviderProps
- type CfnIpAccessSettings
- type CfnIpAccessSettingsProps
- type CfnIpAccessSettings_IpRuleProperty
- type CfnNetworkSettings
- type CfnNetworkSettingsProps
- type CfnPortal
- type CfnPortalProps
- type CfnTrustStore
- type CfnTrustStoreProps
- type CfnUserAccessLoggingSettings
- type CfnUserAccessLoggingSettingsProps
- type CfnUserSettings
- type CfnUserSettingsProps
- type CfnUserSettings_CookieSpecificationProperty
- type CfnUserSettings_CookieSynchronizationConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnBrowserSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnBrowserSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnBrowserSettings_IsCfnElement ¶
func CfnBrowserSettings_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBrowserSettings_IsCfnResource ¶
func CfnBrowserSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBrowserSettings_IsConstruct ¶
func CfnBrowserSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnIdentityProvider_CFN_RESOURCE_TYPE_NAME ¶
func CfnIdentityProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdentityProvider_IsCfnElement ¶
func CfnIdentityProvider_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnIdentityProvider_IsCfnResource ¶
func CfnIdentityProvider_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdentityProvider_IsConstruct ¶
func CfnIdentityProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnIpAccessSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnIpAccessSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnIpAccessSettings_IsCfnElement ¶
func CfnIpAccessSettings_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnIpAccessSettings_IsCfnResource ¶
func CfnIpAccessSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIpAccessSettings_IsConstruct ¶
func CfnIpAccessSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnNetworkSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkSettings_IsCfnElement ¶
func CfnNetworkSettings_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnNetworkSettings_IsCfnResource ¶
func CfnNetworkSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkSettings_IsConstruct ¶
func CfnNetworkSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPortal_CFN_RESOURCE_TYPE_NAME ¶
func CfnPortal_CFN_RESOURCE_TYPE_NAME() *string
func CfnPortal_IsCfnElement ¶
func CfnPortal_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPortal_IsCfnResource ¶
func CfnPortal_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPortal_IsConstruct ¶
func CfnPortal_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTrustStore_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrustStore_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrustStore_IsCfnElement ¶
func CfnTrustStore_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTrustStore_IsCfnResource ¶
func CfnTrustStore_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrustStore_IsConstruct ¶
func CfnTrustStore_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnUserAccessLoggingSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnUserAccessLoggingSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserAccessLoggingSettings_IsCfnElement ¶
func CfnUserAccessLoggingSettings_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUserAccessLoggingSettings_IsCfnResource ¶
func CfnUserAccessLoggingSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserAccessLoggingSettings_IsConstruct ¶
func CfnUserAccessLoggingSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnUserSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnUserSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserSettings_IsCfnElement ¶
func CfnUserSettings_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUserSettings_IsCfnResource ¶
func CfnUserSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserSettings_IsConstruct ¶
func CfnUserSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnBrowserSettings_Override ¶
func NewCfnBrowserSettings_Override(c CfnBrowserSettings, scope constructs.Construct, id *string, props *CfnBrowserSettingsProps)
func NewCfnIdentityProvider_Override ¶
func NewCfnIdentityProvider_Override(c CfnIdentityProvider, scope constructs.Construct, id *string, props *CfnIdentityProviderProps)
func NewCfnIpAccessSettings_Override ¶
func NewCfnIpAccessSettings_Override(c CfnIpAccessSettings, scope constructs.Construct, id *string, props *CfnIpAccessSettingsProps)
func NewCfnNetworkSettings_Override ¶
func NewCfnNetworkSettings_Override(c CfnNetworkSettings, scope constructs.Construct, id *string, props *CfnNetworkSettingsProps)
func NewCfnPortal_Override ¶
func NewCfnPortal_Override(c CfnPortal, scope constructs.Construct, id *string, props *CfnPortalProps)
func NewCfnTrustStore_Override ¶
func NewCfnTrustStore_Override(c CfnTrustStore, scope constructs.Construct, id *string, props *CfnTrustStoreProps)
func NewCfnUserAccessLoggingSettings_Override ¶
func NewCfnUserAccessLoggingSettings_Override(c CfnUserAccessLoggingSettings, scope constructs.Construct, id *string, props *CfnUserAccessLoggingSettingsProps)
func NewCfnUserSettings_Override ¶
func NewCfnUserSettings_Override(c CfnUserSettings, scope constructs.Construct, id *string, props *CfnUserSettingsProps)
Types ¶
type CfnBrowserSettings ¶
type CfnBrowserSettings interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Additional encryption context of the browser settings. AdditionalEncryptionContext() interface{} SetAdditionalEncryptionContext(val interface{}) // A list of web portal ARNs that the browser settings resource is associated with. AttrAssociatedPortalArns() *[]*string // The ARN of the browser settings. AttrBrowserSettingsArn() *string // A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. BrowserPolicy() *string SetBrowserPolicy(val *string) // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The custom managed key of the browser settings. CustomerManagedKey() *string SetCustomerManagedKey(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the browser settings resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies browser settings that can be associated with a web portal.
Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.
Example:
// 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" cfnBrowserSettings := awscdk.Aws_workspacesweb.NewCfnBrowserSettings(this, jsii.String("MyCfnBrowserSettings"), &CfnBrowserSettingsProps{ AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, BrowserPolicy: jsii.String("browserPolicy"), CustomerManagedKey: jsii.String("customerManagedKey"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnBrowserSettings ¶
func NewCfnBrowserSettings(scope constructs.Construct, id *string, props *CfnBrowserSettingsProps) CfnBrowserSettings
type CfnBrowserSettingsProps ¶
type CfnBrowserSettingsProps struct { // Additional encryption context of the browser settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-browsersettings.html#cfn-workspacesweb-browsersettings-additionalencryptioncontext // AdditionalEncryptionContext interface{} `field:"optional" json:"additionalEncryptionContext" yaml:"additionalEncryptionContext"` // A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-browsersettings.html#cfn-workspacesweb-browsersettings-browserpolicy // BrowserPolicy *string `field:"optional" json:"browserPolicy" yaml:"browserPolicy"` // The custom managed key of the browser settings. // // *Pattern* : `^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-browsersettings.html#cfn-workspacesweb-browsersettings-customermanagedkey // CustomerManagedKey *string `field:"optional" json:"customerManagedKey" yaml:"customerManagedKey"` // The tags to add to the browser settings resource. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-browsersettings.html#cfn-workspacesweb-browsersettings-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnBrowserSettings`.
Example:
// 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" cfnBrowserSettingsProps := &CfnBrowserSettingsProps{ AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, BrowserPolicy: jsii.String("browserPolicy"), CustomerManagedKey: jsii.String("customerManagedKey"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnIdentityProvider ¶
type CfnIdentityProvider interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the identity provider. AttrIdentityProviderArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identity provider details. // // The following list describes the provider detail keys for each identity provider type. IdentityProviderDetails() interface{} SetIdentityProviderDetails(val interface{}) // The identity provider name. IdentityProviderName() *string SetIdentityProviderName(val *string) // The identity provider type. IdentityProviderType() *string SetIdentityProviderType(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The ARN of the identity provider. PortalArn() *string SetPortalArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies an identity provider that is then associated with a web portal.
This resource is not required if your portal's `AuthenticationType` is IAM Identity Center.
Example:
// 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" cfnIdentityProvider := awscdk.Aws_workspacesweb.NewCfnIdentityProvider(this, jsii.String("MyCfnIdentityProvider"), &CfnIdentityProviderProps{ IdentityProviderDetails: map[string]*string{ "identityProviderDetailsKey": jsii.String("identityProviderDetails"), }, IdentityProviderName: jsii.String("identityProviderName"), IdentityProviderType: jsii.String("identityProviderType"), // the properties below are optional PortalArn: jsii.String("portalArn"), })
func NewCfnIdentityProvider ¶
func NewCfnIdentityProvider(scope constructs.Construct, id *string, props *CfnIdentityProviderProps) CfnIdentityProvider
type CfnIdentityProviderProps ¶
type CfnIdentityProviderProps struct { // The identity provider details. The following list describes the provider detail keys for each identity provider type. // // - For Google and Login with Amazon: // // - `client_id` // - `client_secret` // - `authorize_scopes` // - For Facebook: // // - `client_id` // - `client_secret` // - `authorize_scopes` // - `api_version` // - For Sign in with Apple: // // - `client_id` // - `team_id` // - `key_id` // - `private_key` // - `authorize_scopes` // - For OIDC providers: // // - `client_id` // - `client_secret` // - `attributes_request_method` // - `oidc_issuer` // - `authorize_scopes` // - `authorize_url` *if not available from discovery URL specified by oidc_issuer key* // - `token_url` *if not available from discovery URL specified by oidc_issuer key* // - `attributes_url` *if not available from discovery URL specified by oidc_issuer key* // - `jwks_uri` *if not available from discovery URL specified by oidc_issuer key* // - For SAML providers: // // - `MetadataFile` OR `MetadataURL` // - `IDPSignout` (boolean) *optional* // - `IDPInit` (boolean) *optional* // - `RequestSigningAlgorithm` (string) *optional* - Only accepts `rsa-sha256` // - `EncryptedResponses` (boolean) *optional*. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityproviderdetails // IdentityProviderDetails interface{} `field:"required" json:"identityProviderDetails" yaml:"identityProviderDetails"` // The identity provider name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityprovidername // IdentityProviderName *string `field:"required" json:"identityProviderName" yaml:"identityProviderName"` // The identity provider type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityprovidertype // IdentityProviderType *string `field:"required" json:"identityProviderType" yaml:"identityProviderType"` // The ARN of the identity provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-portalarn // PortalArn *string `field:"optional" json:"portalArn" yaml:"portalArn"` }
Properties for defining a `CfnIdentityProvider`.
Example:
// 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" cfnIdentityProviderProps := &CfnIdentityProviderProps{ IdentityProviderDetails: map[string]*string{ "identityProviderDetailsKey": jsii.String("identityProviderDetails"), }, IdentityProviderName: jsii.String("identityProviderName"), IdentityProviderType: jsii.String("identityProviderType"), // the properties below are optional PortalArn: jsii.String("portalArn"), }
type CfnIpAccessSettings ¶
type CfnIpAccessSettings interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Additional encryption context of the IP access settings. AdditionalEncryptionContext() interface{} SetAdditionalEncryptionContext(val interface{}) // A list of web portal ARNs that this IP access settings resource is associated with. AttrAssociatedPortalArns() *[]*string // The creation date timestamp of the IP access settings. AttrCreationDate() *string // The ARN of the IP access settings resource. AttrIpAccessSettingsArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The custom managed key of the IP access settings. CustomerManagedKey() *string SetCustomerManagedKey(val *string) // The description of the IP access settings. Description() *string SetDescription(val *string) // The display name of the IP access settings. DisplayName() *string SetDisplayName(val *string) // The IP rules of the IP access settings. IpRules() interface{} SetIpRules(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the IP access settings resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies IP access settings that can be associated with a web portal.
For more information, see [Set up IP access controls (optional)](https://docs.aws.amazon.com/workspaces-web/latest/adminguide/ip-access-controls.html) .
Example:
// 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" cfnIpAccessSettings := awscdk.Aws_workspacesweb.NewCfnIpAccessSettings(this, jsii.String("MyCfnIpAccessSettings"), &CfnIpAccessSettingsProps{ IpRules: []interface{}{ &IpRuleProperty{ IpRange: jsii.String("ipRange"), // the properties below are optional Description: jsii.String("description"), }, }, // the properties below are optional AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, CustomerManagedKey: jsii.String("customerManagedKey"), Description: jsii.String("description"), DisplayName: jsii.String("displayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnIpAccessSettings ¶
func NewCfnIpAccessSettings(scope constructs.Construct, id *string, props *CfnIpAccessSettingsProps) CfnIpAccessSettings
type CfnIpAccessSettingsProps ¶
type CfnIpAccessSettingsProps struct { // The IP rules of the IP access settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-iprules // IpRules interface{} `field:"required" json:"ipRules" yaml:"ipRules"` // Additional encryption context of the IP access settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-additionalencryptioncontext // AdditionalEncryptionContext interface{} `field:"optional" json:"additionalEncryptionContext" yaml:"additionalEncryptionContext"` // 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-]+$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-customermanagedkey // CustomerManagedKey *string `field:"optional" json:"customerManagedKey" yaml:"customerManagedKey"` // The description of the IP access settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-description // Description *string `field:"optional" json:"description" yaml:"description"` // The display name of the IP access settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-displayname // DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"` // The tags to add to the IP access settings resource. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnIpAccessSettings`.
Example:
// 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" cfnIpAccessSettingsProps := &CfnIpAccessSettingsProps{ IpRules: []interface{}{ &IpRuleProperty{ IpRange: jsii.String("ipRange"), // the properties below are optional Description: jsii.String("description"), }, }, // the properties below are optional AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, CustomerManagedKey: jsii.String("customerManagedKey"), Description: jsii.String("description"), DisplayName: jsii.String("displayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnIpAccessSettings_IpRuleProperty ¶
type CfnIpAccessSettings_IpRuleProperty struct { // The IP range of the IP rule. // // This can either be a single IP address or a range using CIDR notation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-ipaccesssettings-iprule.html#cfn-workspacesweb-ipaccesssettings-iprule-iprange // IpRange *string `field:"required" json:"ipRange" yaml:"ipRange"` // The description of the IP rule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-ipaccesssettings-iprule.html#cfn-workspacesweb-ipaccesssettings-iprule-description // Description *string `field:"optional" json:"description" yaml:"description"` }
The IP rules of the IP access settings.
Example:
// 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" ipRuleProperty := &IpRuleProperty{ IpRange: jsii.String("ipRange"), // the properties below are optional Description: jsii.String("description"), }
type CfnNetworkSettings ¶
type CfnNetworkSettings interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // A list of web portal ARNs that this network settings is associated with. AttrAssociatedPortalArns() *[]*string // The ARN of the network settings. AttrNetworkSettingsArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // One or more security groups used to control access from streaming instances to your VPC. SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The subnets in which network interfaces are created to connect streaming instances to your VPC. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // The tags to add to the network settings resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The VPC that streaming instances will connect to. VpcId() *string SetVpcId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies network settings that can be associated with a web portal.
Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.
The VPC must have default tenancy. VPCs with dedicated tenancy are not supported.
For availability consideration, you must have at least two subnets created in two different Availability Zones. WorkSpaces Secure Browser is available in a subset of the Availability Zones for each supported Region. For more information, see [Supported Availability Zones](https://docs.aws.amazon.com/workspaces-web/latest/adminguide/availability-zones.html) .
Example:
// 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" cfnNetworkSettings := awscdk.Aws_workspacesweb.NewCfnNetworkSettings(this, jsii.String("MyCfnNetworkSettings"), &CfnNetworkSettingsProps{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnNetworkSettings ¶
func NewCfnNetworkSettings(scope constructs.Construct, id *string, props *CfnNetworkSettingsProps) CfnNetworkSettings
type CfnNetworkSettingsProps ¶
type CfnNetworkSettingsProps struct { // One or more security groups used to control access from streaming instances to your VPC. // // *Pattern* : `^[\w+\-]+$`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-networksettings.html#cfn-workspacesweb-networksettings-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"` // 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})$`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-networksettings.html#cfn-workspacesweb-networksettings-subnetids // SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` // The VPC that streaming instances will connect to. // // *Pattern* : `^vpc-[0-9a-z]*$`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-networksettings.html#cfn-workspacesweb-networksettings-vpcid // VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"` // The tags to add to the network settings resource. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-networksettings.html#cfn-workspacesweb-networksettings-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnNetworkSettings`.
Example:
// 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" cfnNetworkSettingsProps := &CfnNetworkSettingsProps{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnPortal ¶
type CfnPortal interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The additional encryption context of the portal. AdditionalEncryptionContext() interface{} SetAdditionalEncryptionContext(val interface{}) // The browser that users see when using a streaming session. AttrBrowserType() *string // The creation date of the web portal. AttrCreationDate() *string // The ARN of the web portal. AttrPortalArn() *string // The endpoint URL of the web portal that users access in order to start streaming sessions. AttrPortalEndpoint() *string // The status of the web portal. AttrPortalStatus() *string // The renderer that is used in streaming sessions. AttrRendererType() *string // The SAML metadata of the service provider. AttrServiceProviderSamlMetadata() *string // A message that explains why the web portal is in its current status. AttrStatusReason() *string // The type of authentication integration points used when signing into the web portal. // // Defaults to `Standard` . AuthenticationType() *string SetAuthenticationType(val *string) // The ARN of the browser settings that is associated with this web portal. BrowserSettingsArn() *string SetBrowserSettingsArn(val *string) // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The customer managed key of the web portal. CustomerManagedKey() *string SetCustomerManagedKey(val *string) // The name of the web portal. DisplayName() *string SetDisplayName(val *string) // The type and resources of the underlying instance. InstanceType() *string SetInstanceType(val *string) // The ARN of the IP access settings that is associated with the web portal. IpAccessSettingsArn() *string SetIpAccessSettingsArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum number of concurrent sessions for the portal. MaxConcurrentSessions() *float64 SetMaxConcurrentSessions(val *float64) // The ARN of the network settings that is associated with the web portal. NetworkSettingsArn() *string SetNetworkSettingsArn(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the web portal. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // The ARN of the trust store that is associated with the web portal. TrustStoreArn() *string SetTrustStoreArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ARN of the user access logging settings that is associated with the web portal. UserAccessLoggingSettingsArn() *string SetUserAccessLoggingSettingsArn(val *string) // The ARN of the user settings that is associated with the web portal. UserSettingsArn() *string SetUserSettingsArn(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies a web portal, which users use to start browsing sessions.
A `Standard` web portal can't start browsing sessions unless you have at defined and associated an `IdentityProvider` and `NetworkSettings` resource. An `IAM Identity Center` web portal does not require an `IdentityProvider` resource.
For more information about web portals, see [What is Amazon WorkSpaces Secure Browser?](https://docs.aws.amazon.com/workspaces-web/latest/adminguide/what-is-workspaces-web.html.html) .
Example:
// 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" cfnPortal := awscdk.Aws_workspacesweb.NewCfnPortal(this, jsii.String("MyCfnPortal"), &CfnPortalProps{ AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, AuthenticationType: jsii.String("authenticationType"), BrowserSettingsArn: jsii.String("browserSettingsArn"), CustomerManagedKey: jsii.String("customerManagedKey"), DisplayName: jsii.String("displayName"), InstanceType: jsii.String("instanceType"), IpAccessSettingsArn: jsii.String("ipAccessSettingsArn"), MaxConcurrentSessions: jsii.Number(123), NetworkSettingsArn: jsii.String("networkSettingsArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TrustStoreArn: jsii.String("trustStoreArn"), UserAccessLoggingSettingsArn: jsii.String("userAccessLoggingSettingsArn"), UserSettingsArn: jsii.String("userSettingsArn"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html
func NewCfnPortal ¶
func NewCfnPortal(scope constructs.Construct, id *string, props *CfnPortalProps) CfnPortal
type CfnPortalProps ¶
type CfnPortalProps struct { // The additional encryption context of the portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-additionalencryptioncontext // AdditionalEncryptionContext interface{} `field:"optional" json:"additionalEncryptionContext" yaml:"additionalEncryptionContext"` // The type of authentication integration points used when signing into the web portal. Defaults to `Standard` . // // `Standard` web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps: // // 1. Create and deploy a CloudFormation template with a `Standard` portal with no `IdentityProvider` resource. // // 2. Retrieve the SP metadata using `Fn:GetAtt` , the WorkSpaces Secure Browser console, or by the calling the `GetPortalServiceProviderMetadata` API. // // 3. Submit the data to your IdP. // // 4. Add an `IdentityProvider` resource to your CloudFormation template. // // `IAM Identity Center` web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-authenticationtype // AuthenticationType *string `field:"optional" json:"authenticationType" yaml:"authenticationType"` // The ARN of the browser settings that is associated with this web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-browsersettingsarn // BrowserSettingsArn *string `field:"optional" json:"browserSettingsArn" yaml:"browserSettingsArn"` // The customer managed key of the web portal. // // *Pattern* : `^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-customermanagedkey // CustomerManagedKey *string `field:"optional" json:"customerManagedKey" yaml:"customerManagedKey"` // The name of the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-displayname // DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"` // The type and resources of the underlying instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // The ARN of the IP access settings that is associated with the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-ipaccesssettingsarn // IpAccessSettingsArn *string `field:"optional" json:"ipAccessSettingsArn" yaml:"ipAccessSettingsArn"` // The maximum number of concurrent sessions for the portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-maxconcurrentsessions // MaxConcurrentSessions *float64 `field:"optional" json:"maxConcurrentSessions" yaml:"maxConcurrentSessions"` // The ARN of the network settings that is associated with the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-networksettingsarn // NetworkSettingsArn *string `field:"optional" json:"networkSettingsArn" yaml:"networkSettingsArn"` // The tags to add to the web portal. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The ARN of the trust store that is associated with the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-truststorearn // TrustStoreArn *string `field:"optional" json:"trustStoreArn" yaml:"trustStoreArn"` // The ARN of the user access logging settings that is associated with the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-useraccessloggingsettingsarn // UserAccessLoggingSettingsArn *string `field:"optional" json:"userAccessLoggingSettingsArn" yaml:"userAccessLoggingSettingsArn"` // The ARN of the user settings that is associated with the web portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-usersettingsarn // UserSettingsArn *string `field:"optional" json:"userSettingsArn" yaml:"userSettingsArn"` }
Properties for defining a `CfnPortal`.
Example:
// 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" cfnPortalProps := &CfnPortalProps{ AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, AuthenticationType: jsii.String("authenticationType"), BrowserSettingsArn: jsii.String("browserSettingsArn"), CustomerManagedKey: jsii.String("customerManagedKey"), DisplayName: jsii.String("displayName"), InstanceType: jsii.String("instanceType"), IpAccessSettingsArn: jsii.String("ipAccessSettingsArn"), MaxConcurrentSessions: jsii.Number(123), NetworkSettingsArn: jsii.String("networkSettingsArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TrustStoreArn: jsii.String("trustStoreArn"), UserAccessLoggingSettingsArn: jsii.String("userAccessLoggingSettingsArn"), UserSettingsArn: jsii.String("userSettingsArn"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html
type CfnTrustStore ¶
type CfnTrustStore interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // A list of web portal ARNs that this trust store is associated with. AttrAssociatedPortalArns() *[]*string // The ARN of the trust store. AttrTrustStoreArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // A list of CA certificates to be added to the trust store. CertificateList() *[]*string SetCertificateList(val *[]*string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the trust store. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies a trust store that can be associated with a web portal.
A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.
Example:
// 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" cfnTrustStore := awscdk.Aws_workspacesweb.NewCfnTrustStore(this, jsii.String("MyCfnTrustStore"), &CfnTrustStoreProps{ CertificateList: []*string{ jsii.String("certificateList"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnTrustStore ¶
func NewCfnTrustStore(scope constructs.Construct, id *string, props *CfnTrustStoreProps) CfnTrustStore
type CfnTrustStoreProps ¶
type CfnTrustStoreProps struct { // A list of CA certificates to be added to the trust store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-truststore.html#cfn-workspacesweb-truststore-certificatelist // CertificateList *[]*string `field:"required" json:"certificateList" yaml:"certificateList"` // The tags to add to the trust store. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-truststore.html#cfn-workspacesweb-truststore-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTrustStore`.
Example:
// 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" cfnTrustStoreProps := &CfnTrustStoreProps{ CertificateList: []*string{ jsii.String("certificateList"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUserAccessLoggingSettings ¶
type CfnUserAccessLoggingSettings interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // A list of web portal ARNs that this user access logging settings is associated with. AttrAssociatedPortalArns() *[]*string // The ARN of the user access logging settings. AttrUserAccessLoggingSettingsArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The ARN of the Kinesis stream. KinesisStreamArn() *string SetKinesisStreamArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the user access logging settings resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies user access logging settings that can be associated with a web portal.
In order to receive logs from WorkSpaces Secure Browser, you must have an Amazon Kinesis Data Stream that starts with "amazon-workspaces-web-*". Your Amazon Kinesis data stream must either have server-side encryption turned off, or must use AWS managed keys for server-side encryption.
For more information about setting server-side encryption in Amazon Kinesis , see [How Do I Get Started with Server-Side Encryption?](https://docs.aws.amazon.com/streams/latest/dev/getting-started-with-sse.html) .
For more information about setting up user access logging, see [Set up user access logging](https://docs.aws.amazon.com/workspaces-web/latest/adminguide/user-logging.html) .
Example:
// 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" cfnUserAccessLoggingSettings := awscdk.Aws_workspacesweb.NewCfnUserAccessLoggingSettings(this, jsii.String("MyCfnUserAccessLoggingSettings"), &CfnUserAccessLoggingSettingsProps{ KinesisStreamArn: jsii.String("kinesisStreamArn"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnUserAccessLoggingSettings ¶
func NewCfnUserAccessLoggingSettings(scope constructs.Construct, id *string, props *CfnUserAccessLoggingSettingsProps) CfnUserAccessLoggingSettings
type CfnUserAccessLoggingSettingsProps ¶
type CfnUserAccessLoggingSettingsProps struct { // The ARN of the Kinesis stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-useraccessloggingsettings.html#cfn-workspacesweb-useraccessloggingsettings-kinesisstreamarn // KinesisStreamArn *string `field:"required" json:"kinesisStreamArn" yaml:"kinesisStreamArn"` // The tags to add to the user access logging settings resource. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-useraccessloggingsettings.html#cfn-workspacesweb-useraccessloggingsettings-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnUserAccessLoggingSettings`.
Example:
// 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" cfnUserAccessLoggingSettingsProps := &CfnUserAccessLoggingSettingsProps{ KinesisStreamArn: jsii.String("kinesisStreamArn"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUserSettings ¶
type CfnUserSettings interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The additional encryption context of the user settings. AdditionalEncryptionContext() interface{} SetAdditionalEncryptionContext(val interface{}) // A list of web portal ARNs that this user settings resource is associated with. AttrAssociatedPortalArns() *[]*string // The ARN of the user settings. AttrUserSettingsArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. CookieSynchronizationConfiguration() interface{} SetCookieSynchronizationConfiguration(val interface{}) // Specifies whether the user can copy text from the streaming session to the local device. CopyAllowed() *string SetCopyAllowed(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The customer managed key used to encrypt sensitive information in the user settings. CustomerManagedKey() *string SetCustomerManagedKey(val *string) // Specifies whether the user can use deep links that open automatically when connecting to a session. DeepLinkAllowed() *string SetDeepLinkAllowed(val *string) // The amount of time that a streaming session remains active after users disconnect. DisconnectTimeoutInMinutes() *float64 SetDisconnectTimeoutInMinutes(val *float64) // Specifies whether the user can download files from the streaming session to the local device. DownloadAllowed() *string SetDownloadAllowed(val *string) // The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins. IdleDisconnectTimeoutInMinutes() *float64 SetIdleDisconnectTimeoutInMinutes(val *float64) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Specifies whether the user can paste text from the local device to the streaming session. PasteAllowed() *string SetPasteAllowed(val *string) // Specifies whether the user can print to the local device. PrintAllowed() *string SetPrintAllowed(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to add to the user settings resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Specifies whether the user can upload files from the local device to the streaming session. UploadAllowed() *string SetUploadAllowed(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
This resource specifies user settings that can be associated with a web portal.
Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.
Example:
// 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" cfnUserSettings := awscdk.Aws_workspacesweb.NewCfnUserSettings(this, jsii.String("MyCfnUserSettings"), &CfnUserSettingsProps{ CopyAllowed: jsii.String("copyAllowed"), DownloadAllowed: jsii.String("downloadAllowed"), PasteAllowed: jsii.String("pasteAllowed"), PrintAllowed: jsii.String("printAllowed"), UploadAllowed: jsii.String("uploadAllowed"), // the properties below are optional AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, CookieSynchronizationConfiguration: &CookieSynchronizationConfigurationProperty{ Allowlist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, // the properties below are optional Blocklist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, }, CustomerManagedKey: jsii.String("customerManagedKey"), DeepLinkAllowed: jsii.String("deepLinkAllowed"), DisconnectTimeoutInMinutes: jsii.Number(123), IdleDisconnectTimeoutInMinutes: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnUserSettings ¶
func NewCfnUserSettings(scope constructs.Construct, id *string, props *CfnUserSettingsProps) CfnUserSettings
type CfnUserSettingsProps ¶
type CfnUserSettingsProps struct { // Specifies whether the user can copy text from the streaming session to the local device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-copyallowed // CopyAllowed *string `field:"required" json:"copyAllowed" yaml:"copyAllowed"` // Specifies whether the user can download files from the streaming session to the local device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-downloadallowed // DownloadAllowed *string `field:"required" json:"downloadAllowed" yaml:"downloadAllowed"` // Specifies whether the user can paste text from the local device to the streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-pasteallowed // PasteAllowed *string `field:"required" json:"pasteAllowed" yaml:"pasteAllowed"` // Specifies whether the user can print to the local device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-printallowed // PrintAllowed *string `field:"required" json:"printAllowed" yaml:"printAllowed"` // Specifies whether the user can upload files from the local device to the streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-uploadallowed // UploadAllowed *string `field:"required" json:"uploadAllowed" yaml:"uploadAllowed"` // The additional encryption context of the user settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-additionalencryptioncontext // AdditionalEncryptionContext interface{} `field:"optional" json:"additionalEncryptionContext" yaml:"additionalEncryptionContext"` // The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration // CookieSynchronizationConfiguration interface{} `field:"optional" json:"cookieSynchronizationConfiguration" yaml:"cookieSynchronizationConfiguration"` // The customer managed key used to encrypt sensitive information in the user settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-customermanagedkey // CustomerManagedKey *string `field:"optional" json:"customerManagedKey" yaml:"customerManagedKey"` // Specifies whether the user can use deep links that open automatically when connecting to a session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-deeplinkallowed // DeepLinkAllowed *string `field:"optional" json:"deepLinkAllowed" yaml:"deepLinkAllowed"` // The amount of time that a streaming session remains active after users disconnect. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes // DisconnectTimeoutInMinutes *float64 `field:"optional" json:"disconnectTimeoutInMinutes" yaml:"disconnectTimeoutInMinutes"` // The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes // IdleDisconnectTimeoutInMinutes *float64 `field:"optional" json:"idleDisconnectTimeoutInMinutes" yaml:"idleDisconnectTimeoutInMinutes"` // The tags to add to the user settings resource. // // A tag is a key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnUserSettings`.
Example:
// 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" cfnUserSettingsProps := &CfnUserSettingsProps{ CopyAllowed: jsii.String("copyAllowed"), DownloadAllowed: jsii.String("downloadAllowed"), PasteAllowed: jsii.String("pasteAllowed"), PrintAllowed: jsii.String("printAllowed"), UploadAllowed: jsii.String("uploadAllowed"), // the properties below are optional AdditionalEncryptionContext: map[string]*string{ "additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"), }, CookieSynchronizationConfiguration: &CookieSynchronizationConfigurationProperty{ Allowlist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, // the properties below are optional Blocklist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, }, CustomerManagedKey: jsii.String("customerManagedKey"), DeepLinkAllowed: jsii.String("deepLinkAllowed"), DisconnectTimeoutInMinutes: jsii.Number(123), IdleDisconnectTimeoutInMinutes: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUserSettings_CookieSpecificationProperty ¶
type CfnUserSettings_CookieSpecificationProperty struct { // The domain of the cookie. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-domain // Domain *string `field:"required" json:"domain" yaml:"domain"` // The name of the cookie. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-name // Name *string `field:"optional" json:"name" yaml:"name"` // The path of the cookie. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-path // Path *string `field:"optional" json:"path" yaml:"path"` }
Specifies a single cookie or set of cookies in an end user's browser.
Example:
// 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" cookieSpecificationProperty := &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }
type CfnUserSettings_CookieSynchronizationConfigurationProperty ¶
type CfnUserSettings_CookieSynchronizationConfigurationProperty struct { // The list of cookie specifications that are allowed to be synchronized to the remote browser. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-allowlist // Allowlist interface{} `field:"required" json:"allowlist" yaml:"allowlist"` // The list of cookie specifications that are blocked from being synchronized to the remote browser. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-blocklist // Blocklist interface{} `field:"optional" json:"blocklist" yaml:"blocklist"` }
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
Example:
// 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" cookieSynchronizationConfigurationProperty := &CookieSynchronizationConfigurationProperty{ Allowlist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, // the properties below are optional Blocklist: []interface{}{ &CookieSpecificationProperty{ Domain: jsii.String("domain"), // the properties below are optional Name: jsii.String("name"), Path: jsii.String("path"), }, }, }
Source Files ¶
- CfnBrowserSettings.go
- CfnBrowserSettingsProps.go
- CfnBrowserSettings__checks.go
- CfnIdentityProvider.go
- CfnIdentityProviderProps.go
- CfnIdentityProvider__checks.go
- CfnIpAccessSettings.go
- CfnIpAccessSettingsProps.go
- CfnIpAccessSettings_IpRuleProperty.go
- CfnIpAccessSettings__checks.go
- CfnNetworkSettings.go
- CfnNetworkSettingsProps.go
- CfnNetworkSettings__checks.go
- CfnPortal.go
- CfnPortalProps.go
- CfnPortal__checks.go
- CfnTrustStore.go
- CfnTrustStoreProps.go
- CfnTrustStore__checks.go
- CfnUserAccessLoggingSettings.go
- CfnUserAccessLoggingSettingsProps.go
- CfnUserAccessLoggingSettings__checks.go
- CfnUserSettings.go
- CfnUserSettingsProps.go
- CfnUserSettings_CookieSpecificationProperty.go
- CfnUserSettings_CookieSynchronizationConfigurationProperty.go
- CfnUserSettings__checks.go
- main.go